Class SerializerDetails

Constructor is internal API.

Use one of the Create factory methods instead

Inheritance

object

SerializerDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Serialization

Assembly: Akka.dll

Syntax

public sealed class SerializerDetails

Properties

Alias

The name of the serializer - must be unique.

Declaration

public string Alias { get; }

Property Value

Type	Description
string

Examples

i.e. "json" for the global JSON.NET serializer "IDomainSerializer" for a custom serializer that serializes "IDomain" messages, etc.

Serializer

The serializer that belongs to this Alias.

Declaration

public Serializer Serializer { get; }

Property Value

Type	Description
Serializer

UseFor

The types of messages that this

Declaration

public ImmutableHashSet<Type> UseFor { get; }

Property Value

Type	Description
ImmutableHashSet<Type>

Methods

Create(string, Serializer, ImmutableHashSet<Type>)

Factory method for creating programmatic setups for Serializers.

Declaration

public static SerializerDetails Create(string alias, Serializer serializer, ImmutableHashSet<Type> useFor)

Parameters

Type	Name	Description
string	alias	Register the serializer under this alias (this allows it to be used by bindings in the config)
Serializer	serializer	The serializer implementation.
ImmutableHashSet<Type>	useFor	A set of types (classes, base classes, or interfaces) that will be bound to this serializer. This is the programmatic equivalent of the akka.actor.serialization.serialization-bindings HOCON section.

Returns

Type	Description
SerializerDetails

Create(string, SerializerV2, ImmutableHashSet<Type>)

Factory method for creating programmatic setups for Serializers.

Declaration

public static SerializerDetails Create(string alias, SerializerV2 serializer, ImmutableHashSet<Type> useFor)

Parameters

Type	Name	Description
string	alias	Register the serializer under this alias (this allows it to be used by bindings in the config)
SerializerV2	serializer	The serializer implementation.
ImmutableHashSet<Type>	useFor	A set of types (classes, base classes, or interfaces) that will be bound to this serializer. This is the programmatic equivalent of the akka.actor.serialization.serialization-bindings HOCON section.

Returns

Type	Description
SerializerDetails

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)