Class HyperionSerializerSetup

Inheritance
Object
Setup
HyperionSerializerSetup
Inherited Members
Namespace: Akka.Serialization.Hyperion
Assembly: Akka.Serialization.Hyperion.dll
Syntax
public class HyperionSerializerSetup : Setup

Fields

| Improve this Doc View Source

Empty

Declaration
public static readonly HyperionSerializerSetup Empty
Field Value
Type Description
HyperionSerializerSetup

Properties

| Improve this Doc View Source

DisallowUnsafeType

If set, will cause the Hyperion serializer to block potentially dangerous and unsafe types from being deserialized during run-time. Defaults to true.

Declaration
public bool? DisallowUnsafeType { get; }
Property Value
Type Description
Nullable<Boolean>
| Improve this Doc View Source

KnownTypesProvider

A type implementing IKnownTypesProvider, that will be used when HyperionSerializer is being constructed to provide a list of message types that are supposed to be known implicitly by all communicating parties. Implementing class must provide either a default constructor or a constructor taking ExtendedActorSystem as its only parameter.

Declaration
public Type KnownTypesProvider { get; }
Property Value
Type Description
Type
| Improve this Doc View Source

PackageNameOverrides

A list of lambda functions, used to transform incoming deserialized package names before they are instantiated. Used to provide cross-platform compatibility.

Declaration
public IEnumerable<Func<string, string>> PackageNameOverrides { get; }
Property Value
Type Description
IEnumerable<Func<String, String>>
| Improve this Doc View Source

PreserveObjectReferences

When true, it tells HyperionSerializer to keep track of references in serialized/deserialized object graph.

Declaration
public bool? PreserveObjectReferences { get; }
Property Value
Type Description
Nullable<Boolean>
| Improve this Doc View Source

Surrogates

A list of Surrogate instances that are used to de/serialize complex objects into a much simpler serialized objects.

Declaration
public IEnumerable<Surrogate> Surrogates { get; }
Property Value
Type Description
IEnumerable<Hyperion.Surrogate>
| Improve this Doc View Source

TypeFilter

Declaration
public ITypeFilter TypeFilter { get; }
Property Value
Type Description
Hyperion.ITypeFilter
| Improve this Doc View Source

VersionTolerance

When true, it tells HyperionSerializer to encode a list of currently serialized fields into type manifest.

Declaration
public bool? VersionTolerance { get; }
Property Value
Type Description
Nullable<Boolean>

Methods

| Improve this Doc View Source

Create(Boolean, Boolean, Type)

Declaration
public static HyperionSerializerSetup Create(bool preserveObjectReferences, bool versionTolerance, Type knownTypesProvider)
Parameters
Type Name Description
Boolean preserveObjectReferences
Boolean versionTolerance
Type knownTypesProvider
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

Create(Boolean, Boolean, Type, IEnumerable<Func<String, String>>)

Declaration
public static HyperionSerializerSetup Create(bool preserveObjectReferences, bool versionTolerance, Type knownTypesProvider, IEnumerable<Func<string, string>> packageNameOverrides)
Parameters
Type Name Description
Boolean preserveObjectReferences
Boolean versionTolerance
Type knownTypesProvider
IEnumerable<Func<String, String>> packageNameOverrides
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

Create(Boolean, Boolean, Type, IEnumerable<Func<String, String>>, IEnumerable<Surrogate>)

Declaration
public static HyperionSerializerSetup Create(bool preserveObjectReferences, bool versionTolerance, Type knownTypesProvider, IEnumerable<Func<string, string>> packageNameOverrides, IEnumerable<Surrogate> surrogates)
Parameters
Type Name Description
Boolean preserveObjectReferences
Boolean versionTolerance
Type knownTypesProvider
IEnumerable<Func<String, String>> packageNameOverrides
IEnumerable<Hyperion.Surrogate> surrogates
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

Create(Boolean, Boolean, Type, IEnumerable<Func<String, String>>, IEnumerable<Surrogate>, Boolean)

Declaration
public static HyperionSerializerSetup Create(bool preserveObjectReferences, bool versionTolerance, Type knownTypesProvider, IEnumerable<Func<string, string>> packageNameOverrides, IEnumerable<Surrogate> surrogates, bool disallowUnsafeType)
Parameters
Type Name Description
Boolean preserveObjectReferences
Boolean versionTolerance
Type knownTypesProvider
IEnumerable<Func<String, String>> packageNameOverrides
IEnumerable<Hyperion.Surrogate> surrogates
Boolean disallowUnsafeType
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

Create(Boolean, Boolean, Type, IEnumerable<Func<String, String>>, IEnumerable<Surrogate>, Boolean, ITypeFilter)

Declaration
public static HyperionSerializerSetup Create(bool preserveObjectReferences, bool versionTolerance, Type knownTypesProvider, IEnumerable<Func<string, string>> packageNameOverrides, IEnumerable<Surrogate> surrogates, bool disallowUnsafeType, ITypeFilter typeFilter)
Parameters
Type Name Description
Boolean preserveObjectReferences
Boolean versionTolerance
Type knownTypesProvider
IEnumerable<Func<String, String>> packageNameOverrides
IEnumerable<Hyperion.Surrogate> surrogates
Boolean disallowUnsafeType
Hyperion.ITypeFilter typeFilter
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

WithDisallowUnsafeType(Boolean)

Declaration
public HyperionSerializerSetup WithDisallowUnsafeType(bool disallowUnsafeType)
Parameters
Type Name Description
Boolean disallowUnsafeType
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

WithKnownTypeProvider(Type)

Declaration
public HyperionSerializerSetup WithKnownTypeProvider(Type knownTypeProvider)
Parameters
Type Name Description
Type knownTypeProvider
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

WithKnownTypeProvider<T>()

Declaration
public HyperionSerializerSetup WithKnownTypeProvider<T>()
Returns
Type Description
HyperionSerializerSetup
Type Parameters
Name Description
T
| Improve this Doc View Source

WithPackageNameOverrides(IEnumerable<Func<String, String>>)

Declaration
public HyperionSerializerSetup WithPackageNameOverrides(IEnumerable<Func<string, string>> packageNameOverrides)
Parameters
Type Name Description
IEnumerable<Func<String, String>> packageNameOverrides
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

WithPreserveObjectReference(Boolean)

Declaration
public HyperionSerializerSetup WithPreserveObjectReference(bool preserveObjectReference)
Parameters
Type Name Description
Boolean preserveObjectReference
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

WithSurrogates(IEnumerable<Surrogate>)

Declaration
public HyperionSerializerSetup WithSurrogates(IEnumerable<Surrogate> surrogates)
Parameters
Type Name Description
IEnumerable<Hyperion.Surrogate> surrogates
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

WithTypeFilter(ITypeFilter)

Declaration
public HyperionSerializerSetup WithTypeFilter(ITypeFilter typeFilter)
Parameters
Type Name Description
Hyperion.ITypeFilter typeFilter
Returns
Type Description
HyperionSerializerSetup
| Improve this Doc View Source

WithVersionTolerance(Boolean)

Declaration
public HyperionSerializerSetup WithVersionTolerance(bool versionTolerance)
Parameters
Type Name Description
Boolean versionTolerance
Returns
Type Description
HyperionSerializerSetup

Extension Methods