final class ClusterMessageSerializer extends SerializerWithStringManifest with BaseSerializer
Protobuf serializer of cluster messages.
- Alphabetic
- By Inheritance
- ClusterMessageSerializer
- BaseSerializer
- SerializerWithStringManifest
- Serializer
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ClusterMessageSerializer(system: ExtendedActorSystem)
Value Members
-
final
val
SerializationIdentifiers: String("akka.actor.serialization-identifiers")
Configuration namespace of serialization identifiers in the
reference.conf
.Configuration namespace of serialization identifiers in the
reference.conf
.Each serializer implementation must have an entry in the following format:
akka.actor.serialization-identifiers."FQCN" = ID
whereFQCN
is fully qualified class name of the serializer implementation andID
is globally unique serializer identifier number.- Definition Classes
- BaseSerializer
- def compress(msg: MessageLite): Array[Byte]
- def decompress(bytes: Array[Byte]): Array[Byte]
- def deserializeClusterRouterPool(bytes: Array[Byte]): ClusterRouterPool
- def deserializeHeartBeat(bytes: Array[Byte]): Heartbeat
- def deserializeHeartBeatResponse(bytes: Array[Byte]): HeartbeatRsp
-
def
fromBinary(bytes: Array[Byte], manifest: String): AnyRef
Produces an object from an array of bytes, with an optional type-hint.
Produces an object from an array of bytes, with an optional type-hint.
It's recommended to throw
java.io.NotSerializableException
infromBinary
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.- Definition Classes
- ClusterMessageSerializer → SerializerWithStringManifest
-
final
def
fromBinary(bytes: Array[Byte], manifest: Option[Class[_]]): AnyRef
Produces an object from an array of bytes, with an optional type-hint; the class should be loaded using ActorSystem.dynamicAccess.
Produces an object from an array of bytes, with an optional type-hint; the class should be loaded using ActorSystem.dynamicAccess.
- Definition Classes
- SerializerWithStringManifest → Serializer
-
final
def
fromBinary(bytes: Array[Byte], clazz: Class[_]): AnyRef
Java API: deserialize with type hint
Java API: deserialize with type hint
- Definition Classes
- Serializer
- Annotations
- @throws( classOf[NotSerializableException] )
-
final
def
fromBinary(bytes: Array[Byte]): AnyRef
Java API: deserialize without type hint
Java API: deserialize without type hint
- Definition Classes
- Serializer
-
val
identifier: Int
Globally unique serialization identifier configured in the
reference.conf
.Globally unique serialization identifier configured in the
reference.conf
.- Definition Classes
- BaseSerializer → Serializer
-
final
def
includeManifest: Boolean
Returns whether this serializer needs a manifest in the fromBinary method
Returns whether this serializer needs a manifest in the fromBinary method
- Definition Classes
- SerializerWithStringManifest → Serializer
-
def
manifest(o: AnyRef): String
Return the manifest (type hint) that will be provided in the fromBinary method.
Return the manifest (type hint) that will be provided in the fromBinary method. Use
""
if manifest is not needed.- Definition Classes
- ClusterMessageSerializer → SerializerWithStringManifest
-
val
system: ExtendedActorSystem
Actor system which is required by most serializer implementations.
Actor system which is required by most serializer implementations.
- Definition Classes
- ClusterMessageSerializer → BaseSerializer
-
def
toBinary(obj: AnyRef): Array[Byte]
Serializes the given object into an Array of Byte
Serializes the given object into an Array of Byte
- Definition Classes
- ClusterMessageSerializer → SerializerWithStringManifest → Serializer