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 pekko.actor.ActorSystem start-up, where two constructors are tried in order:

  • taking exactly one argument of type pekko.actor.ExtendedActorSystem; this should be the preferred one because all reflective loading of classes during deserialization should use ExtendedActorSystem.dynamicAccess (see pekko.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 pekko.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
ServiceKeySerializer, AbstractSerializationSupport, ReplicatedDataSerializer, ReplicatorMessageSerializer, MessageSerializer, ClusterMessageSerializer, TestSerializer, MessageSerializer, SnapshotSerializer, MessageContainerSerializer, MiscMessageSerializer, ProtobufSerializer, SystemMessageSerializer, AsyncSerializerWithStringManifest, AsyncSerializerWithStringManifestCS, BaseSerializer, ByteArraySerializer, DisabledJavaSerializer, JSerializer, JavaSerializer, NullSerializer, NullSerializer, SerializerWithStringManifest, TestJavaSerializer, ByteStringSerializer, IntSerializer, LongSerializer, StringSerializer
Type Hierarchy
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. Protected

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.

    Produces an object from an array of bytes, with an optional type-hint; the class should be loaded using ActorSystem.dynamicAccess.

    Annotations
    @throws(classOf[NotSerializableException])
  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 Pekko 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.

    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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Serializer toany2stringadd[Serializer] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Serializer, B)
    Implicit
    This member is added by an implicit conversion from Serializer toArrowAssoc[Serializer] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (Serializer) => Boolean, msg: => Any): Serializer
    Implicit
    This member is added by an implicit conversion from Serializer toEnsuring[Serializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Serializer) => Boolean): Serializer
    Implicit
    This member is added by an implicit conversion from Serializer toEnsuring[Serializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Serializer
    Implicit
    This member is added by an implicit conversion from Serializer toEnsuring[Serializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Serializer
    Implicit
    This member is added by an implicit conversion from Serializer toEnsuring[Serializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def fromBinary(bytes: Array[Byte], clazz: Class[_]): AnyRef

    Java API: deserialize with type hint

    Java API: deserialize with type hint

    Annotations
    @throws(classOf[NotSerializableException])
  15. final def fromBinary(bytes: Array[Byte]): AnyRef

    Java API: deserialize without type hint

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Serializer toStringFormat[Serializer] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Serializer, B)
    Implicit
    This member is added by an implicit conversion from Serializer toArrowAssoc[Serializer] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSerializer to any2stringadd[Serializer]

Inherited by implicit conversion StringFormat fromSerializer to StringFormat[Serializer]

Inherited by implicit conversion Ensuring fromSerializer to Ensuring[Serializer]

Inherited by implicit conversion ArrowAssoc fromSerializer to ArrowAssoc[Serializer]

Ungrouped