Package akka.cluster.protobuf

Class ClusterMessageSerializer

java.lang.Object

akka.serialization.SerializerWithStringManifest

akka.cluster.protobuf.ClusterMessageSerializer

All Implemented Interfaces:

BaseSerializer, Serializer

public final class ClusterMessageSerializer
extends SerializerWithStringManifest
implements BaseSerializer

Protobuf serializer of cluster messages.

Constructor Summary

Constructors

Constructor	Description
ClusterMessageSerializer(ExtendedActorSystem system)

Method Summary

Modifier and Type	Method	Description
ClusterMessages.Address.Builder	addressToProto(Address address)
byte[]	addressToProtoByteArray(Address address)
protected void	akka$serialization$BaseSerializer$_setter_$identifier_$eq(int x$1)
static java.lang.String	ClusterRouterPoolManifest()
byte[]	compress(akka.protobuf.MessageLite msg)
byte[]	decompress(byte[] bytes)
ClusterRouterPool	deserializeClusterRouterPool(byte[] bytes)
ClusterHeartbeatSender.Heartbeat	deserializeHeartBeat(byte[] bytes)
ClusterHeartbeatSender.HeartbeatRsp	deserializeHeartBeatResponse(byte[] bytes)
static java.lang.String	DownManifest()
static java.lang.String	ExitingConfirmedManifest()
java.lang.Object	fromBinary(byte[] bytes, java.lang.String manifest)	Produces an object from an array of bytes, with an optional type-hint.
static java.lang.String	GossipEnvelopeManifest()
static java.lang.String	GossipStatusManifest()
static java.lang.String	HeartBeatManifest()
static java.lang.String	HeartBeatManifestPre2523()
static java.lang.String	HeartBeatRspManifest()
static java.lang.String	HeartBeatRspManifest2523()
int	identifier()	Completely unique value to identify this implementation of Serializer, used to optimize network traffic.
static java.lang.String	InitJoinAckManifest()
static java.lang.String	InitJoinManifest()
static java.lang.String	InitJoinNackManifest()
static java.lang.String	JoinManifest()
static java.lang.String	LeaveManifest()
java.lang.String	manifest(java.lang.Object o)	Return the manifest (type hint) that will be provided in the fromBinary method.
ExtendedActorSystem	system()	Actor system which is required by most serializer implementations.
byte[]	toBinary(java.lang.Object obj)	Serializes the given object into an Array of Byte
ClusterMessages.UniqueAddress.Builder	uniqueAddressToProto(UniqueAddress uniqueAddress)
static java.lang.String	WelcomeManifest()

Methods inherited from class akka.serialization.SerializerWithStringManifest

fromBinary, includeManifest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akka.serialization.BaseSerializer

identifierFromConfig, SerializationIdentifiers

Methods inherited from interface akka.serialization.Serializer

fromBinary, fromBinary, fromBinary, includeManifest

Constructor Detail

ClusterMessageSerializer

public ClusterMessageSerializer(ExtendedActorSystem system)

Method Detail

JoinManifest

public static java.lang.String JoinManifest()

WelcomeManifest

public static java.lang.String WelcomeManifest()

LeaveManifest

public static java.lang.String LeaveManifest()

DownManifest

public static java.lang.String DownManifest()

InitJoinManifest

public static java.lang.String InitJoinManifest()

InitJoinAckManifest

public static java.lang.String InitJoinAckManifest()

InitJoinNackManifest

public static java.lang.String InitJoinNackManifest()

HeartBeatManifestPre2523

public static java.lang.String HeartBeatManifestPre2523()

HeartBeatRspManifest2523

public static java.lang.String HeartBeatRspManifest2523()

HeartBeatManifest

public static java.lang.String HeartBeatManifest()

HeartBeatRspManifest

public static java.lang.String HeartBeatRspManifest()

ExitingConfirmedManifest

public static java.lang.String ExitingConfirmedManifest()

GossipStatusManifest

public static java.lang.String GossipStatusManifest()

GossipEnvelopeManifest

public static java.lang.String GossipEnvelopeManifest()

ClusterRouterPoolManifest

public static java.lang.String ClusterRouterPoolManifest()

identifier

public int identifier()

Description copied from interface: Serializer

Completely unique value to identify this implementation of Serializer, used to optimize network traffic. Values from 0 to 40 are reserved for Akka internal usage.

Specified by:

identifier in interface BaseSerializer

Specified by:

identifier in interface Serializer

Specified by:

identifier in class SerializerWithStringManifest

Returns:

(undocumented)

akka$serialization$BaseSerializer$_setter_$identifier_$eq

protected void akka$serialization$BaseSerializer$_setter_$identifier_$eq(int x$1)

Specified by:

akka$serialization$BaseSerializer$_setter_$identifier_$eq in interface BaseSerializer

system

public ExtendedActorSystem system()

Description copied from interface: BaseSerializer

Actor system which is required by most serializer implementations.

Specified by:

system in interface BaseSerializer

Returns:

(undocumented)

manifest

public java.lang.String manifest(java.lang.Object o)

Description copied from class: SerializerWithStringManifest

Return the manifest (type hint) that will be provided in the fromBinary method. Use "" if manifest is not needed.

Specified by:

manifest in class SerializerWithStringManifest

Parameters:

o - (undocumented)

Returns:

(undocumented)

toBinary

public byte[] toBinary(java.lang.Object obj)

Description copied from class: SerializerWithStringManifest

Serializes the given object into an Array of Byte

Specified by:

toBinary in interface Serializer

Specified by:

toBinary in class SerializerWithStringManifest

Parameters:

obj - (undocumented)

Returns:

(undocumented)

fromBinary

public java.lang.Object fromBinary(byte[] bytes,
                                   java.lang.String manifest)

Description copied from class: SerializerWithStringManifest

Produces an object from an array of bytes, with an optional type-hint.

It's recommended to throw java.io.NotSerializableException in fromBinary if the manifest is unknown. This makes it possible to introduce new message types and send them to nodes that don't know about them. This is typically needed when performing rolling upgrades, i.e. running a cluster with mixed versions for while. NotSerializableException is treated as a transient problem in the TCP based remoting layer. The problem will be logged and message is dropped. Other exceptions will tear down the TCP connection because it can be an indication of corrupt bytes from the underlying transport.

Specified by:

fromBinary in class SerializerWithStringManifest

Parameters:

bytes - (undocumented)

manifest - (undocumented)

Returns:

(undocumented)

compress

public byte[] compress(akka.protobuf.MessageLite msg)

decompress

public byte[] decompress(byte[] bytes)

addressToProto

public ClusterMessages.Address.Builder addressToProto(Address address)

addressToProtoByteArray

public byte[] addressToProtoByteArray(Address address)

uniqueAddressToProto

public ClusterMessages.UniqueAddress.Builder uniqueAddressToProto(UniqueAddress uniqueAddress)

deserializeHeartBeat

public ClusterHeartbeatSender.Heartbeat deserializeHeartBeat(byte[] bytes)

deserializeHeartBeatResponse

public ClusterHeartbeatSender.HeartbeatRsp deserializeHeartBeatResponse(byte[] bytes)

deserializeClusterRouterPool

public ClusterRouterPool deserializeClusterRouterPool(byte[] bytes)