Class BaseMessage

  • Direct Known Subclasses:
    RequestMessage, ResponseMessage

    public abstract class BaseMessage
    extends SpyObject
    The BaseMessage implements the header of a tap message. This class cannot be instantiated. Tap stream messages are created with the RequestMessage and ResponseMessage classes.
    • Constructor Detail

      • BaseMessage

        protected BaseMessage()
      • BaseMessage

        protected BaseMessage​(byte[] b)
    • Method Detail

      • setMagic

        public final void setMagic​(TapMagic m)
        Sets the value of the tap messages magic field.
        Parameters:
        m - The new value for the magic field.
      • getMagic

        public final TapMagic getMagic()
        Gets the value of the tap messages magic field.
        Returns:
        The value of the magic field.
      • setOpcode

        public final void setOpcode​(TapOpcode o)
        Sets the value of the tap messages opcode field.
        Parameters:
        o - The new value of the opcode field.
      • getOpcode

        public final TapOpcode getOpcode()
        Gets the value of the tap messages opaque field.
        Returns:
        The value of the opaque field.
      • getKeylength

        public final short getKeylength()
        Gets the value of the tap messages key length field.
        Returns:
        The value of the key length field.
      • setDatatype

        public final void setDatatype​(byte d)
        Sets the value of the tap messages data type field.
        Parameters:
        d - The new value for the data type field.
      • getDatatype

        public final byte getDatatype()
        Gets the value of the tap messages data type field.
        Returns:
        The value of the data type field.
      • setExtralength

        public final void setExtralength​(byte e)
        Sets the value of the tap messages extra length field.
        Parameters:
        e - The new value for the extra length field.
      • getExtralength

        public final byte getExtralength()
        Gets the value of the tap messages extra length field.
        Returns:
        The value of the extra length field.
      • setVbucket

        public final void setVbucket​(short vb)
        Sets the value of the tap messages vbucket field.
        Parameters:
        vb - The new value for the vbucket field.
      • getVbucket

        public final short getVbucket()
        Gets the value of the tap messages vbucket field.
        Returns:
        The value of the vbucket field.
      • setTotalbody

        public final void setTotalbody​(int t)
        Sets the value of the tap messages total body field.
        Parameters:
        t - The new value for the total body field.
      • getTotalbody

        public final int getTotalbody()
        Gets the value of the tap messages total body field.
        Returns:
        The value of the total body field.
      • setOpaque

        public final void setOpaque​(int op)
        Sets the value of the tap messages opaque field.
        Parameters:
        op - The new value for the opaque field.
      • getOpaque

        public final int getOpaque()
        Gets the value of the tap messages opaque field.
        Returns:
        The value of the opaque field.
      • setCas

        public final void setCas​(long c)
        Sets the value of the tap messages cas field.
        Parameters:
        c - The new value for the cas field.
      • getCas

        public final long getCas()
        Gets the value of the tap messages cas field.
        Returns:
        The value of the cas field.
      • getMessageLength

        public final int getMessageLength()
        Gets the length of the entire message.
        Returns:
        The length of the message.
      • getBytes

        public abstract java.nio.ByteBuffer getBytes()
        Creates a ByteBuffer representation of the message.
        Returns:
        The ByteBuffer representation of the message.
      • decodeShort

        protected short decodeShort​(byte[] data,
                                    int i)
      • decodeInt

        protected int decodeInt​(byte[] data,
                                int i)
      • decodeIntHostOrder

        protected int decodeIntHostOrder​(byte[] data,
                                         int i)
      • decodeLong

        protected long decodeLong​(byte[] data,
                                  int i)