t

akka.serialization

Serializer

trait Serializer extends AnyRef

A Serializer represents a bimap between an object and an array of bytes representing that object.

Serializers are loaded using reflection during akka.actor.ActorSystem start-up, where two constructors are tried in order:

  • taking exactly one argument of type akka.actor.ExtendedActorSystem; this should be the preferred one because all reflective loading of classes during deserialization should use ExtendedActorSystem.dynamicAccess (see akka.actor.DynamicAccess), and
  • without arguments, which is only an option if the serializer does not load classes using reflection.

Be sure to always use the akka.actor.DynamicAccess for loading classes! This is necessary to avoid strange match errors and inequalities which arise from different class loaders loading the same class.

Source
Serializer.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AbstractSerializationSupport, ReplicatedDataSerializer, ReplicatorMessageSerializer, MessageSerializer, ClusterMessageSerializer, MessageSerializer, SnapshotSerializer, ByteStringSerializer, IntSerializer, LongSerializer, MessageContainerSerializer, MiscMessageSerializer, ProtobufSerializer, StringSerializer, SystemMessageSerializer, BaseSerializer, ByteArraySerializer, DisabledJavaSerializer, JSerializer, JavaSerializer, NullSerializer, NullSerializer, SerializerWithStringManifest
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Serializer
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract 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.

  2. abstract def identifier: Int

    Completely unique value to identify this implementation of Serializer, used to optimize network traffic.

    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.

  3. abstract def includeManifest: Boolean

    Returns whether this serializer needs a manifest in the fromBinary method

  4. abstract def toBinary(o: AnyRef): Array[Byte]

    Serializes the given object into an Array of Byte

Concrete Value Members

  1. final def fromBinary(bytes: Array[Byte], clazz: Class[_]): AnyRef

    Java API: deserialize with type hint

  2. final def fromBinary(bytes: Array[Byte]): AnyRef

    Java API: deserialize without type hint