Package org.apache.pekko.remote.artery

Interface HeaderBuilder

public interface HeaderBuilder
INTERNAL API

  • Method Details

    • setVersion

      void setVersion(byte v)

    • version

      byte version()

    • setFlags

      void setFlags(byte v)

    • flags

      byte flags()

    • flag

      boolean flag(org.apache.pekko.remote.artery.ByteFlag byteFlag)

    • setFlag

      void setFlag(org.apache.pekko.remote.artery.ByteFlag byteFlag)

    • clearFlag

      void clearFlag(org.apache.pekko.remote.artery.ByteFlag byteFlag)

    • inboundActorRefCompressionTableVersion

      byte inboundActorRefCompressionTableVersion()

    • inboundClassManifestCompressionTableVersion

      byte inboundClassManifestCompressionTableVersion()

    • useOutboundCompression

      void useOutboundCompression(boolean on)

    • outboundActorRefCompression

      <any> outboundActorRefCompression()

    • setOutboundActorRefCompression

      void setOutboundActorRefCompression(<any> table)

    • outboundClassManifestCompression

      <any> outboundClassManifestCompression()

    • setOutboundClassManifestCompression

      void setOutboundClassManifestCompression(<any> table)

    • setUid

      void setUid(long u)

    • uid

      long uid()

    • setSenderActorRef

      void setSenderActorRef(ActorRef ref)

    • senderActorRef

      <any> senderActorRef(long originUid)
      Retrieve the compressed ActorRef by the compressionId carried by this header. Returns None if ActorRef was not compressed, and then the literal senderActorRefPath() should be used.

    • senderActorRefPath

      <any> senderActorRefPath()
      Retrieve the raw literal actor path, instead of using the compressed value. Returns None if ActorRef was compressed (!). To obtain the path in such case call senderActorRef(long) and extract the path from it directly.

    • setNoSender

      void setNoSender()

    • isNoSender

      boolean isNoSender()

    • setNoRecipient

      void setNoRecipient()

    • isNoRecipient

      boolean isNoRecipient()

    • setRecipientActorRef

      void setRecipientActorRef(ActorRef ref)

    • recipientActorRef

      <any> recipientActorRef(long originUid)
      Retrieve the compressed ActorRef by the compressionId carried by this header. Returns None if ActorRef was not compressed, and then the literal recipientActorRefPath() should be used.

    • recipientActorRefPath

      <any> recipientActorRefPath()
      Retrieve the raw literal actor path, instead of using the compressed value. Returns None if ActorRef was compressed (!). To obtain the path in such case call recipientActorRefPath() and extract the path from it directly.

    • setSerializer

      void setSerializer(int serializer)

    • serializer

      int serializer()

    • setManifest

      void setManifest(String manifest)

    • manifest

      <any> manifest(long originUid)

    • setRemoteInstruments

      void setRemoteInstruments(org.apache.pekko.remote.artery.RemoteInstruments instruments)

    • resetMessageFields

      void resetMessageFields()
      Reset all fields that are related to an outbound message, i.e. Encoder calls this as the first thing in onPush.