Class ResponseMessage


public class ResponseMessage extends BaseMessage
A representation of a tap stream message sent from a tap stream server.
  • Field Details

    • ENGINE_PRIVATE_OFFSET

      private static final int ENGINE_PRIVATE_OFFSET
      See Also:
    • FLAGS_OFFSET

      private static final int FLAGS_OFFSET
      See Also:
    • TTL_OFFSET

      private static final int TTL_OFFSET
      See Also:
    • RESERVED1_OFFSET

      private static final int RESERVED1_OFFSET
      See Also:
    • RESERVED2_OFFSET

      private static final int RESERVED2_OFFSET
      See Also:
    • RESERVED3_OFFSET

      private static final int RESERVED3_OFFSET
      See Also:
    • ITEM_FLAGS_OFFSET

      private static final int ITEM_FLAGS_OFFSET
      See Also:
    • ITEM_EXPIRY_OFFSET

      private static final int ITEM_EXPIRY_OFFSET
      See Also:
    • KEY_OFFSET

      private static final int KEY_OFFSET
      See Also:
    • engineprivate

      private final short engineprivate
    • flags

      private final List<TapResponseFlag> flags
    • ttl

      private final byte ttl
    • reserved1

      private final byte reserved1
    • reserved2

      private final byte reserved2
    • reserved3

      private final byte reserved3
    • itemflags

      private final int itemflags
    • itemexpiry

      private int itemexpiry
    • vbucketstate

      private final int vbucketstate
    • checkpoint

      private final long checkpoint
    • key

      private final byte[] key
    • value

      private final byte[] value
    • revid

      private final byte[] revid
  • Constructor Details

    • ResponseMessage

      public ResponseMessage(byte[] b)
      Creates a ResponseMessage from binary data.
      Parameters:
      b - The binary data sent from the tap stream server.
  • Method Details

    • getEnginePrivate

      public long getEnginePrivate()
      Gets the value of the engine private field. Not returned in a no-op message.
      Returns:
      The engine private data.
    • getFlags

      public List<TapResponseFlag> getFlags()
      Gets the value of the flags field. Not returned in a no-op message.
      Returns:
      The flags data.
    • getTTL

      public int getTTL()
      Gets the value of the time to live field. Not returned in a no-op message.
      Returns:
      The time to live value;
    • getReserved1

      protected int getReserved1()
      Gets the value of the reserved1 field. Not returned in a no-op message.
      Returns:
      The reserved1 data.
    • getReserved2

      protected int getReserved2()
      Gets the value of the reserved2 field. Not returned in a no-op message.
      Returns:
      The reserved2 data.
    • getReserved3

      protected int getReserved3()
      Gets the value of the reserved3 field. Not returned in a no-op message.
      Returns:
      The reserved3 data.
    • getVBucketState

      public int getVBucketState()
      Gets the state of the vbucket. Only returned with a tap vbucket state message.
      Returns:
      the vbucket state
    • getCheckpoint

      public long getCheckpoint()
      Gets the checkpoint of the vbucket. Only returned with a start/end checkpoint message.
      Returns:
      the checkpoint
    • getItemFlags

      public int getItemFlags()
      Gets the value of the items flag field. Only returned with a tap mutation message.
      Returns:
      The items flag data.
    • getItemExpiry

      public long getItemExpiry()
      Gets the value of the item expiry field. Only returned with a tap mutation message.
      Returns:
      The item expiry data.
    • getKey

      public String getKey()
      Gets the value of the key field. Only returned with a tap mutation or tap delete message.
      Returns:
      The key data.
    • getValue

      public byte[] getValue()
      Gets the value of the value field. Only returned with a tap mutation message.
      Returns:
      The value data.
    • getRevID

      public byte[] getRevID()
      Gets the value of the revid field. Only returned with a tap mutation message.
      Returns:
      The revid of the document.
    • getBytes

      public ByteBuffer getBytes()
      Description copied from class: BaseMessage
      Creates a ByteBuffer representation of the message.
      Specified by:
      getBytes in class BaseMessage
      Returns:
      The ByteBuffer representation of the message.
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • deserialize

      private Object deserialize()
      Attempt to get the object represented by the given serialized bytes.