final class ClusterMessageSerializer extends SerializerWithStringManifest with BaseSerializer
Protobuf serializer of cluster messages.
- Alphabetic
- By Inheritance
- ClusterMessageSerializer
- BaseSerializer
- SerializerWithStringManifest
- Serializer
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ClusterMessageSerializer(system: ExtendedActorSystem)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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" = IDwhereFQCNis fully qualified class name of the serializer implementation andIDis globally unique serializer identifier number.- Definition Classes
- BaseSerializer
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def compress(msg: MessageLite): Array[Byte]
- def decompress(bytes: Array[Byte]): Array[Byte]
- def deserializeClusterRouterPool(bytes: Array[Byte]): ClusterRouterPool
- def deserializeHeartBeat(bytes: Array[Byte]): Heartbeat
- def deserializeHeartBeatResponse(bytes: Array[Byte]): HeartbeatRsp
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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.NotSerializableExceptioninfromBinaryif 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.NotSerializableExceptionis 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
- ClusterMessageSerializer → SerializerWithStringManifest
- 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
- 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])
- final def fromBinary(bytes: Array[Byte]): AnyRef
Java API: deserialize without type hint
Java API: deserialize without type hint
- Definition Classes
- Serializer
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- ClusterMessageSerializer → SerializerWithStringManifest
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val system: ExtendedActorSystem
Actor system which is required by most serializer implementations.
Actor system which is required by most serializer implementations.
- Definition Classes
- ClusterMessageSerializer → BaseSerializer
- 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
- ClusterMessageSerializer → SerializerWithStringManifest → Serializer
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.