Packages

final class PayloadSerializer extends SerializerWithStringManifest with BaseSerializer

INTERNAL API

Annotations
@InternalApi()
Source
PayloadSerializer.scala
Linear Supertypes
BaseSerializer, SerializerWithStringManifest, Serializer, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PayloadSerializer
  2. BaseSerializer
  3. SerializerWithStringManifest
  4. Serializer
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PayloadSerializer(system: ExtendedActorSystem)

Value Members

  1. 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 where FQCN is fully qualified class name of the serializer implementation and ID is globally unique serializer identifier number.

    Definition Classes
    BaseSerializer
  2. 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.

    Definition Classes
    PayloadSerializer → SerializerWithStringManifest
  3. 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
  4. 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])
  5. final def fromBinary(bytes: Array[Byte]): AnyRef

    Java API: deserialize without type hint

    Java API: deserialize without type hint

    Definition Classes
    Serializer
  6. val identifier: Int

    Globally unique serialization identifier configured in the reference.conf.

    Globally unique serialization identifier configured in the reference.conf.

    See Serializer.identifier.

    Definition Classes
    BaseSerializer → Serializer
  7. 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
  8. 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
    PayloadSerializer → SerializerWithStringManifest
  9. val system: ExtendedActorSystem

    Actor system which is required by most serializer implementations.

    Actor system which is required by most serializer implementations.

    Definition Classes
    PayloadSerializer → BaseSerializer
  10. def toBinary(o: 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.

    Definition Classes
    PayloadSerializer → SerializerWithStringManifest → Serializer