Class HyperionSerializerSetup

Inheritance

object

Setup

HyperionSerializerSetup

Inherited Members

Setup.And(Setup)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Serialization.Hyperion

Assembly: Akka.Serialization.Hyperion.dll

Syntax

public class HyperionSerializerSetup : Setup

Fields

Empty

Declaration

public static readonly HyperionSerializerSetup Empty

Field Value

Type	Description
HyperionSerializerSetup

Properties

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
bool?

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

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>>

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
bool?

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<Surrogate>

TypeFilter

Declaration

public ITypeFilter TypeFilter { get; }

Property Value

Type	Description
ITypeFilter

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
bool?

Methods

Create(bool, bool, Type)

Declaration

public static HyperionSerializerSetup Create(bool preserveObjectReferences, bool versionTolerance, Type knownTypesProvider)

Parameters

Type	Name	Description
bool	preserveObjectReferences
bool	versionTolerance
Type	knownTypesProvider

Returns

Type	Description
HyperionSerializerSetup

Create(bool, bool, 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
bool	preserveObjectReferences
bool	versionTolerance
Type	knownTypesProvider
IEnumerable<Func<string, string>>	packageNameOverrides

Returns

Type	Description
HyperionSerializerSetup

Create(bool, bool, 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
bool	preserveObjectReferences
bool	versionTolerance
Type	knownTypesProvider
IEnumerable<Func<string, string>>	packageNameOverrides
IEnumerable<Surrogate>	surrogates

Returns

Type	Description
HyperionSerializerSetup

Create(bool, bool, Type, IEnumerable<Func<string, string>>, IEnumerable<Surrogate>, bool)

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
bool	preserveObjectReferences
bool	versionTolerance
Type	knownTypesProvider
IEnumerable<Func<string, string>>	packageNameOverrides
IEnumerable<Surrogate>	surrogates
bool	disallowUnsafeType

Returns

Type	Description
HyperionSerializerSetup

Create(bool, bool, Type, IEnumerable<Func<string, string>>, IEnumerable<Surrogate>, bool, 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
bool	preserveObjectReferences
bool	versionTolerance
Type	knownTypesProvider
IEnumerable<Func<string, string>>	packageNameOverrides
IEnumerable<Surrogate>	surrogates
bool	disallowUnsafeType
ITypeFilter	typeFilter

Returns

Type	Description
HyperionSerializerSetup

WithDisallowUnsafeType(bool)

Declaration

public HyperionSerializerSetup WithDisallowUnsafeType(bool disallowUnsafeType)

Parameters

Type	Name	Description
bool	disallowUnsafeType

Returns

Type	Description
HyperionSerializerSetup

WithKnownTypeProvider(Type)

Declaration

public HyperionSerializerSetup WithKnownTypeProvider(Type knownTypeProvider)

Parameters

Type	Name	Description
Type	knownTypeProvider

Returns

Type	Description
HyperionSerializerSetup

WithKnownTypeProvider<T>()

Declaration

public HyperionSerializerSetup WithKnownTypeProvider<T>()

Returns

Type	Description
HyperionSerializerSetup

Type Parameters

Name	Description
T

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

WithPreserveObjectReference(bool)

Declaration

public HyperionSerializerSetup WithPreserveObjectReference(bool preserveObjectReference)

Parameters

Type	Name	Description
bool	preserveObjectReference

Returns

Type	Description
HyperionSerializerSetup

WithSurrogates(IEnumerable<Surrogate>)

Declaration

public HyperionSerializerSetup WithSurrogates(IEnumerable<Surrogate> surrogates)

Parameters

Type	Name	Description
IEnumerable<Surrogate>	surrogates

Returns

Type	Description
HyperionSerializerSetup

WithTypeFilter(ITypeFilter)

Declaration

public HyperionSerializerSetup WithTypeFilter(ITypeFilter typeFilter)

Parameters

Type	Name	Description
ITypeFilter	typeFilter

Returns

Type	Description
HyperionSerializerSetup

WithVersionTolerance(bool)

Declaration

public HyperionSerializerSetup WithVersionTolerance(bool versionTolerance)

Parameters

Type	Name	Description
bool	versionTolerance

Returns

Type	Description
HyperionSerializerSetup

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)