ReplicatorMessageSerializer

org.apache.pekko.cluster.ddata.protobuf.ReplicatorMessageSerializer

Protobuf serializer of ReplicatorMessage messages.

Attributes

Source
ReplicatorMessageSerializer.scala
Graph
Supertypes
trait Serializer
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override 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 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.

Attributes

Definition Classes
Source
ReplicatorMessageSerializer.scala
override def manifest(obj: AnyRef): String

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

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

Attributes

Definition Classes
Source
ReplicatorMessageSerializer.scala
def toBinary(obj: AnyRef): Array[Byte]

Serializes the given object into an Array of Byte.

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.

Attributes

Source
ReplicatorMessageSerializer.scala

Inherited methods

def addressFromProto(address: Address): Address

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala
def addressToProto(address: Address): Builder

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala
def decompress(bytes: Array[Byte]): Array[Byte]

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala
final def fromBinary(bytes: Array[Byte], clazz: Class[_]): AnyRef

Java API: deserialize with type hint

Java API: deserialize with type hint

Attributes

Inherited from:
Serializer
Source
Serializer.scala
final def fromBinary(bytes: Array[Byte]): AnyRef

Java API: deserialize without type hint

Java API: deserialize without type hint

Attributes

Inherited from:
Serializer
Source
Serializer.scala
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.

Attributes

Inherited from:
SerializerWithStringManifest
Source
Serializer.scala
final override 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

Attributes

Definition Classes
Inherited from:
SerializerWithStringManifest
Source
Serializer.scala
def otherMessageFromBinary(bytes: Array[Byte]): AnyRef

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala
def otherMessageFromProto(other: OtherMessage): AnyRef

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala
def otherMessageToProto(msg: Any): OtherMessage

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala
def uniqueAddressFromProto(uniqueAddress: UniqueAddress): UniqueAddress

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala
def uniqueAddressToProto(uniqueAddress: UniqueAddress): Builder

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala
def versionVectorFromProto(versionVector: VersionVector): VersionVector

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala
def versionVectorToProto(versionVector: VersionVector): VersionVector

Attributes

Inherited from:
SerializationSupport
Source
SerializationSupport.scala

Concrete fields

val ChangedManifest: String
val GetManifest: String
val GossipManifest: String
val NotFoundManifest: String
val ReadManifest: String
val StatusManifest: String
val WriteAckManifest: String
val WriteManifest: String

Actor system which is required by most serializer implementations.

Actor system which is required by most serializer implementations.

Attributes

Source
ReplicatorMessageSerializer.scala

Inherited fields

final val SerializationIdentifiers: "pekko.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: org.apache.pekko.actor.serialization-identifiers."FQCN" = ID where FQCN is fully qualified class name of the serializer implementation and ID is globally unique serializer identifier number.

Attributes

Inherited from:
BaseSerializer
Source
Serializer.scala
override val identifier: Int

Globally unique serialization identifier configured in the reference.conf.

Globally unique serialization identifier configured in the reference.conf.

See pekko.serialization.Serializer.identifier.

Attributes

Inherited from:
BaseSerializer
Source
Serializer.scala