Class ClusterClientMessageSerializer

INTERNAL API.

Serializer used to translate all of the ClusterClient and ClusterClientReceptionist messages that can be passed back-and-forth between client and receptionist.

Inheritance
Object
Serializer
SerializerWithStringManifest
ClusterClientMessageSerializer
Inherited Members
Namespace: Akka.Cluster.Tools.Client.Serialization
Assembly: Akka.Cluster.Tools.dll
Syntax
public class ClusterClientMessageSerializer : SerializerWithStringManifest

Constructors

| Improve this Doc View Source

ClusterClientMessageSerializer(ExtendedActorSystem)

Initializes a new instance of the ClusterClientMessageSerializer class.

Declaration
public ClusterClientMessageSerializer(ExtendedActorSystem system)
Parameters
Type Name Description
ExtendedActorSystem system

The actor system to associate with this serializer.

Methods

| Improve this Doc View Source

FromBinary(Byte[], String)

Deserializes a byte array into an object using an optional manifest (type hint).

Declaration
public override object FromBinary(byte[] bytes, string manifest)
Parameters
Type Name Description
Byte[] bytes

The array containing the serialized object
String manifest

The type hint used to deserialize the object contained in the array.
Returns
Type Description
Object

The object contained in the array
Overrides
Exceptions
Type Condition
ArgumentException

This exception is thrown when the specified bytescannot be deserialized using the specified manifest.
| Improve this Doc View Source

Manifest(Object)

Returns the manifest (type hint) that will be provided in the FromBinary(Byte[], String) method.

note

This method returns Empty if a manifest is not needed.

Declaration
public override string Manifest(object o)
Parameters
Type Name Description
Object o

The object for which the manifest is needed.
Returns
Type Description
String

The manifest needed for the deserialization of the specified o.
Overrides
Exceptions
Type Condition
ArgumentException

This exception is thrown when the specified o does not have an associated manifest.
| Improve this Doc View Source

ToBinary(Object)

Serializes the given object into a byte array

Declaration
public override byte[] ToBinary(object obj)
Parameters
Type Name Description
Object obj

The object to serialize
Returns
Type Description
Byte[]

A byte array containing the serialized object
Overrides
Exceptions
Type Condition
ArgumentException

This exception is thrown when the specified obj is of an unknown type. Acceptable values include: Akka.Cluster.Tools.Client.ClusterReceptionist.Contacts | Akka.Cluster.Tools.Client.ClusterReceptionist.GetContacts | Akka.Cluster.Tools.Client.ClusterReceptionist.Heartbeat | Akka.Cluster.Tools.Client.ClusterReceptionist.HeartbeatRsp

Extension Methods