Class SerializerDetails

Constructor is internal API.

Use the Create(String, Serializer, ImmutableHashSet<Type>) factory method instead

Inheritance
Object
SerializerDetails
Inherited Members
Namespace: Akka.Serialization
Assembly: Akka.dll
Syntax
public sealed class SerializerDetails

Properties

| Improve this Doc View Source

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.

| Improve this Doc View Source

Serializer

The serializer that belongs to this Alias.

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

UseFor

The types of messages that this

Declaration
public ImmutableHashSet<Type> UseFor { get; }
Property Value
Type Description
System.Collections.Immutable.ImmutableHashSet<Type>

Methods

| Improve this Doc View Source

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.
System.Collections.Immutable.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