Package akka.persistence.serialization

Class PayloadSerializer

java.lang.Object

akka.serialization.SerializerWithStringManifest

akka.persistence.serialization.PayloadSerializer

All Implemented Interfaces:

BaseSerializer, Serializer

public final class PayloadSerializer
extends SerializerWithStringManifest
implements BaseSerializer

INTERNAL API

Constructor Summary

Constructors

Constructor	Description
PayloadSerializer(ExtendedActorSystem system)

Method Summary

Modifier and Type	Method	Description
protected void	akka$serialization$BaseSerializer$_setter_$identifier_$eq(int x$1)	Globally unique serialization identifier configured in the reference.conf.
java.lang.Object	fromBinary(byte[] bytes, java.lang.String manifest)	Produces an object from an array of bytes, with an optional type-hint.
int	identifier()	Completely unique value to identify this implementation of Serializer, used to optimize network traffic.
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 o)	Serializes the given object into an Array of Byte.

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

PayloadSerializer

public PayloadSerializer(ExtendedActorSystem system)

Method Detail

akka$serialization$BaseSerializer$_setter_$identifier_$eq

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

Description copied from interface: BaseSerializer

Globally unique serialization identifier configured in the reference.conf.

See Serializer.identifier.

Specified by:

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

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

identifier

public int identifier()

Description copied from class: SerializerWithStringManifest

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

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

system

public ExtendedActorSystem system()

Description copied from interface: BaseSerializer

Actor system which is required by most serializer implementations.

Specified by:

system in interface BaseSerializer

toBinary

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

Description copied from class: SerializerWithStringManifest

Serializes the given object into an Array of Byte.

Note that the array must not be mutated by the serializer after it has been returned.

Specified by:

toBinary in interface Serializer

Specified by:

toBinary in class SerializerWithStringManifest