Package org.apache.pekko.cluster.protobuf

Class ClusterMessageSerializer

java.lang.Object
org.apache.pekko.serialization.SerializerWithStringManifest
org.apache.pekko.cluster.protobuf.ClusterMessageSerializer
All Implemented Interfaces:
BaseSerializer, Serializer
public final class ClusterMessageSerializer extends SerializerWithStringManifest implements BaseSerializer
Protobuf serializer of cluster messages.

  • Constructor Details

  • Method Details

    • OldJoinManifest

      public static String OldJoinManifest()

    • OldWelcomeManifest

      public static String OldWelcomeManifest()

    • OldLeaveManifest

      public static String OldLeaveManifest()

    • OldDownManifest

      public static String OldDownManifest()

    • OldInitJoinManifest

      public static String OldInitJoinManifest()

    • OldInitJoinAckManifest

      public static String OldInitJoinAckManifest()

    • OldInitJoinNackManifest

      public static String OldInitJoinNackManifest()

    • HeartBeatManifestPre2523

      public static String HeartBeatManifestPre2523()

    • HeartBeatRspManifest2523

      public static String HeartBeatRspManifest2523()

    • OldExitingConfirmedManifest

      public static String OldExitingConfirmedManifest()

    • OldGossipStatusManifest

      public static String OldGossipStatusManifest()

    • OldGossipEnvelopeManifest

      public static String OldGossipEnvelopeManifest()

    • OldClusterRouterPoolManifest

      public static String OldClusterRouterPoolManifest()

    • JoinManifest

      public static String JoinManifest()

    • WelcomeManifest

      public static String WelcomeManifest()

    • LeaveManifest

      public static String LeaveManifest()

    • DownManifest

      public static String DownManifest()

    • PrepareForShutdownManifest

      public static String PrepareForShutdownManifest()

    • InitJoinManifest

      public static String InitJoinManifest()

    • InitJoinAckManifest

      public static String InitJoinAckManifest()

    • InitJoinNackManifest

      public static String InitJoinNackManifest()

    • HeartbeatManifest

      public static String HeartbeatManifest()

    • HeartbeatRspManifest

      public static String HeartbeatRspManifest()

    • ExitingConfirmedManifest

      public static String ExitingConfirmedManifest()

    • GossipStatusManifest

      public static String GossipStatusManifest()

    • GossipEnvelopeManifest

      public static String GossipEnvelopeManifest()

    • ClusterRouterPoolManifest

      public static String ClusterRouterPoolManifest()

    • identifier

      public int identifier()
      Description copied from class: SerializerWithStringManifest
      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.
      Specified by:
      identifier in interface BaseSerializer
      Specified by:
      identifier in interface Serializer
      Specified by:
      identifier in class SerializerWithStringManifest

    • org$apache$pekko$serialization$BaseSerializer$_setter_$identifier_$eq

      protected void org$apache$pekko$serialization$BaseSerializer$_setter_$identifier_$eq(int x$1)
      Description copied from interface: BaseSerializer
      Globally unique serialization identifier configured in the reference.conf.

      See pekko.serialization.Serializer.identifier.

      Specified by:
      org$apache$pekko$serialization$BaseSerializer$_setter_$identifier_$eq in interface BaseSerializer

    • system

      public ExtendedActorSystem system()
      Description copied from interface: BaseSerializer
      Actor system which is required by most serializer implementations.
      Specified by:
      system in interface BaseSerializer

    • manifest

      public String manifest(Object o)
      Description copied from class: SerializerWithStringManifest
      Return the manifest (type hint) that will be provided in the fromBinary method. Use "" if manifest is not needed.
      Specified by:
      manifest in class SerializerWithStringManifest

    • toBinary

      public byte[] toBinary(Object obj)
      Description copied from class: SerializerWithStringManifest
      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.

      Specified by:
      toBinary in interface Serializer
      Specified by:
      toBinary in class SerializerWithStringManifest

    • fromBinary

      public Object fromBinary(byte[] bytes, String manifest)
      Description copied from class: SerializerWithStringManifest
      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.

      Specified by:
      fromBinary in class SerializerWithStringManifest

    • compress

      public byte[] compress(org.apache.pekko.protobufv3.internal.MessageLite msg)

    • decompress

      public byte[] decompress(byte[] bytes)

    • deserializeHeartBeat

      public org.apache.pekko.cluster.ClusterHeartbeatSender.Heartbeat deserializeHeartBeat(byte[] bytes)

    • deserializeHeartBeatResponse

      public org.apache.pekko.cluster.ClusterHeartbeatSender.HeartbeatRsp deserializeHeartBeatResponse(byte[] bytes)

    • deserializeClusterRouterPool

      public ClusterRouterPool deserializeClusterRouterPool(byte[] bytes)