Packages

c

akka.cluster.protobuf

ClusterMessageSerializer

final class ClusterMessageSerializer extends SerializerWithStringManifest with BaseSerializer

Protobuf serializer of cluster messages.

Source
ClusterMessageSerializer.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterMessageSerializer
  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 ClusterMessageSerializer(system: ExtendedActorSystem)

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 ClusterMessageSerializer toany2stringadd[ClusterMessageSerializer] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClusterMessageSerializer, B)
    Implicit
    This member is added by an implicit conversion from ClusterMessageSerializer toArrowAssoc[ClusterMessageSerializer] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def compress(msg: MessageLite): Array[Byte]
  10. def decompress(bytes: Array[Byte]): Array[Byte]
  11. def deserializeClusterRouterPool(bytes: Array[Byte]): ClusterRouterPool
  12. def deserializeHeartBeat(bytes: Array[Byte]): Heartbeat
  13. def deserializeHeartBeatResponse(bytes: Array[Byte]): HeartbeatRsp
  14. def ensuring(cond: (ClusterMessageSerializer) => Boolean, msg: => Any): ClusterMessageSerializer
    Implicit
    This member is added by an implicit conversion from ClusterMessageSerializer toEnsuring[ClusterMessageSerializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (ClusterMessageSerializer) => Boolean): ClusterMessageSerializer
    Implicit
    This member is added by an implicit conversion from ClusterMessageSerializer toEnsuring[ClusterMessageSerializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): ClusterMessageSerializer
    Implicit
    This member is added by an implicit conversion from ClusterMessageSerializer toEnsuring[ClusterMessageSerializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): ClusterMessageSerializer
    Implicit
    This member is added by an implicit conversion from ClusterMessageSerializer toEnsuring[ClusterMessageSerializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. 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
    ClusterMessageSerializerSerializerWithStringManifest
  21. 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
    SerializerWithStringManifestSerializer
  22. 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])
  23. final def fromBinary(bytes: Array[Byte]): AnyRef

    Java API: deserialize without type hint

    Java API: deserialize without type hint

    Definition Classes
    Serializer
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. 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
    BaseSerializerSerializer
  27. 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
    SerializerWithStringManifestSerializer
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. 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
    ClusterMessageSerializerSerializerWithStringManifest
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. val system: ExtendedActorSystem

    Actor system which is required by most serializer implementations.

    Actor system which is required by most serializer implementations.

    Definition Classes
    ClusterMessageSerializerBaseSerializer
  35. 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.

    Definition Classes
    ClusterMessageSerializerSerializerWithStringManifestSerializer
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. 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
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClusterMessageSerializer toStringFormat[ClusterMessageSerializer] 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): (ClusterMessageSerializer, B)
    Implicit
    This member is added by an implicit conversion from ClusterMessageSerializer toArrowAssoc[ClusterMessageSerializer] 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 BaseSerializer

Inherited from Serializer

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterMessageSerializer to any2stringadd[ClusterMessageSerializer]

Inherited by implicit conversion StringFormat fromClusterMessageSerializer to StringFormat[ClusterMessageSerializer]

Inherited by implicit conversion Ensuring fromClusterMessageSerializer to Ensuring[ClusterMessageSerializer]

Inherited by implicit conversion ArrowAssoc fromClusterMessageSerializer to ArrowAssoc[ClusterMessageSerializer]

Ungrouped