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

SerializerWithStringManifest.IncludeManifest

SerializerWithStringManifest.FromBinary(byte[], Type)

Serializer.system

Serializer.Identifier

Serializer.ToBinaryWithAddress(Address, object)

Serializer.FromBinary<T>(byte[])

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Cluster.Tools.Client.Serialization

Assembly: Akka.Cluster.Tools.dll

Syntax

public class ClusterClientMessageSerializer : SerializerWithStringManifest

Constructors

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

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

SerializerWithStringManifest.FromBinary(byte[], string)

Exceptions

Type	Condition
ArgumentException	This exception is thrown when the specified bytescannot be deserialized using the specified manifest.

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

SerializerWithStringManifest.Manifest(object)

Exceptions

Type	Condition
ArgumentException	This exception is thrown when the specified o does not have an associated manifest.

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

Serializer.ToBinary(object)

Exceptions

Type	Condition
ArgumentException	This exception is thrown when the specified obj is of an unknown type. Acceptable values include: ClusterReceptionist.Contacts | ClusterReceptionist.GetContacts | ClusterReceptionist.Heartbeat | ClusterReceptionist.HeartbeatRsp

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)