Package pcap.spi

Interface PacketBuffer

All Superinterfaces:
AutoCloseable
public interface PacketBuffer extends AutoCloseable
Used to wrap low-level memory address.

Creation of a buffer:

Pcap pcap = ..; PacketBuffer buffer = pcap.allocate(PacketBuffer.class).capacity(8); assert buffer.release();

Since:
1.0.0
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    PacketBuffer.ByteOrder
    Byte order.
    static interface 
    PacketBuffer.Charset
    Charset.
    static interface 
    PacketBuffer.Sliced
    Indicate the buffer is sliced.

  • Method Summary

    Modifier and Type
    Method
    Description
    PacketBuffer.ByteOrder
    byteOrder()
    Retrieves this buffer's native byte order.
    PacketBuffer
    byteOrder(PacketBuffer.ByteOrder byteOrder)
    Change this buffer's byte order.
    long
    capacity()
    Get buffer capacity.
    PacketBuffer
    capacity(long newCapacity)
    Reallocate buffer.
    <T extends Packet.Abstract>
    T
    cast(Class<T> t)
    Casting buffer to Packet.
    PacketBuffer
    clear()
    Sets the readerIndex and writerIndex of this buffer to 0.
    PacketBuffer
    copy()
    Returns a copy of this buffer's readable bytes.
    PacketBuffer
    copy(long index, long length)
    Returns a copy of this buffer's sub-region.
    PacketBuffer
    duplicate()
    Duplicate the this PacketBuffer buffer.
    PacketBuffer
    ensureWritable(long minWritableBytes)
    Makes sure the number of the writable bytes is equal to or greater than the specified value.
    boolean
    getBoolean(long index)
    Gets a boolean at the specified absolute (@code index) in this buffer.
    byte
    getByte(long index)
    Gets a byte at the specified absolute index in this buffer.
    PacketBuffer
    getBytes(long index, byte[] dst)
    Transfers this buffer's data to the specified destination starting at the specified absolute index.
    PacketBuffer
    getBytes(long index, byte[] dst, long dstIndex, long length)
    Transfers this buffer's data to the specified destination starting at the specified absolute index.
    PacketBuffer
    getBytes(long index, PacketBuffer dst)
    Transfers this buffer's data to the specified destination starting at the specified absolute index until the destination becomes non-writable.
    PacketBuffer
    getBytes(long index, PacketBuffer dst, long length)
    Transfers this buffer's data to the specified destination starting at the specified absolute index.
    PacketBuffer
    getBytes(long index, PacketBuffer dst, long dstIndex, long length)
    Transfers this buffer's data to the specified destination starting at the specified absolute index.
    CharSequence
    getCharSequence(long index, long length, PacketBuffer.Charset charset)
    Gets a CharSequence with the given length at the given index.
    double
    getDouble(long index)
    Gets a 64-bit floating point number at the specified absolute index in this buffer.
    double
    getDoubleRE(long index)
    Gets a 64-bit floating point number at the specified absolute index in this buffer in Reserved Native Endian Byte Order.
    float
    getFloat(long index)
    Gets a 32-bit floating point number at the specified absolute index in this buffer.
    float
    getFloatRE(long index)
    Gets a 32-bit floating point number at the specified absolute index in this buffer in Reserved Native Endian Byte Order.
    int
    getInt(long index)
    Gets a 32-bit integer at the specified absolute index in this buffer.
    int
    getIntRE(long index)
    Gets a 32-bit integer at the specified absolute index in this buffer with Reserved Native Endian Byte Order.
    long
    getLong(long index)
    Gets a 64-bit long integer at the specified absolute index in this buffer.
    long
    getLongRE(long index)
    Gets a 64-bit long integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order.
    short
    getShort(long index)
    Gets a 16-bit short integer at the specified absolute index in this buffer.
    short
    getShortRE(long index)
    Gets a 16-bit short integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order.
    short
    getUnsignedByte(long index)
    Gets an unsigned byte at the specified absolute index in this buffer.
    long
    getUnsignedInt(long index)
    Gets an unsigned 32-bit integer at the specified absolute index in this buffer.
    long
    getUnsignedIntRE(long index)
    Gets an unsigned 32-bit integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order.
    int
    getUnsignedShort(long index)
    Gets an unsigned 16-bit short integer at the specified absolute index in this buffer.
    int
    getUnsignedShortRE(long index)
    Gets an unsigned 16-bit short integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order.
    boolean
    isReadable()
     
    boolean
    isReadable(long numBytes)
     
    boolean
    isWritable()
     
    boolean
    isWritable(long numBytes)
     
    PacketBuffer
    markReaderIndex()
    Marks the current readerIndex in this buffer.
    PacketBuffer
    markWriterIndex()
    Marks the current writerIndex in this buffer.
    long
    memoryAddress()
    Get the first byte memory address of this PacketBuffer.
    long
    readableBytes()
    Get readable bytes from a buffer.
    boolean
    readBoolean()
    Gets a boolean at the current readerIndex and increases the readerIndex by 1 in this buffer.
    byte
    readByte()
    Gets a byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
    PacketBuffer
    readBytes(byte[] dst)
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= dst.length).
    PacketBuffer
    readBytes(byte[] dst, long dstIndex, long length)
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
    PacketBuffer
    readBytes(PacketBuffer dst)
    Transfers this buffer's data to the specified destination starting at the current readerIndex until the destination becomes non-writable, and increases the readerIndex by the number of the transferred bytes.
    PacketBuffer
    readBytes(PacketBuffer dst, long length)
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
    PacketBuffer
    readBytes(PacketBuffer dst, long dstIndex, long length)
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
    CharSequence
    readCharSequence(long length, PacketBuffer.Charset charset)
    Gets a CharSequence with the given length at the current readerIndex and increases the readerIndex by the given length.
    double
    readDouble()
    Gets a 64-bit floating point number at the current readerIndex and increases the readerIndex by 8 in this buffer.
    double
    readDoubleRE()
    Gets a 64-bit floating point number at the current readerIndex in Reserved Native Endian Byte Order and increases the readerIndex by 8 in this buffer.
    long
    readerIndex()
    Get reader buffer index.
    PacketBuffer
    readerIndex(long readerIndex)
    Sets the readerIndex of this buffer.
    float
    readFloat()
    Gets a 32-bit floating point number at the current readerIndex and increases the readerIndex by 4 in this buffer.
    float
    readFloatRE()
    Gets a 32-bit floating point number at the current readerIndex in Reserved Native Endian Byte Order and increases the readerIndex by 4 in this buffer.
    int
    readInt()
    Gets a 32-bit integer at the current readerIndex and increases the readerIndex by 4 in this buffer.
    int
    readIntRE()
    Gets a 32-bit integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 4 in this buffer.
    long
    readLong()
    Gets a 64-bit integer at the current readerIndex and increases the readerIndex by 8 in this buffer.
    long
    readLongRE()
    Gets a 64-bit integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 8 in this buffer.
    short
    readShort()
    Gets a 16-bit short integer at the current readerIndex and increases the readerIndex by 2 in this buffer.
    short
    readShortRE()
    Gets a 16-bit short integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 2 in this buffer.
    short
    readUnsignedByte()
    Gets an unsigned byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
    long
    readUnsignedInt()
    Gets an unsigned 32-bit integer at the current readerIndex and increases the readerIndex by 4 in this buffer.
    long
    readUnsignedIntRE()
    Gets an unsigned 32-bit integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 4 in this buffer.
    int
    readUnsignedShort()
    Gets an unsigned 16-bit short integer at the current readerIndex and increases the readerIndex by 2 in this buffer.
    int
    readUnsignedShortRE()
    Gets an unsigned 16-bit short integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 2 in this buffer.
    boolean
    release()
    Release this PacketBuffer buffer
    PacketBuffer
    resetReaderIndex()
    Repositions the current readerIndex to the marked readerIndex in this buffer.
    PacketBuffer
    resetWriterIndex()
    Repositions the current writerIndex to the marked writerIndex in this buffer.
    PacketBuffer
    setBoolean(long index, boolean value)
    Sets the specified boolean at the specified absolute index in this buffer.
    PacketBuffer
    setByte(long index, int value)
    Sets the specified byte at the specified absolute index in this buffer.
    PacketBuffer
    setBytes(long index, byte[] src)
    Transfers the specified source array's data to this buffer starting at the specified absolute index.
    PacketBuffer
    setBytes(long index, byte[] src, long srcIndex, long length)
    Transfers the specified source array's data to this buffer starting at the specified absolute index.
    PacketBuffer
    setBytes(long index, PacketBuffer src)
    Transfers the specified source buffer's data to this buffer starting at the specified absolute index until the source buffer becomes unreadable.
    PacketBuffer
    setBytes(long index, PacketBuffer src, long length)
    Transfers the specified source buffer's data to this buffer starting at the specified absolute index.
    PacketBuffer
    setBytes(long index, PacketBuffer src, long srcIndex, long length)
    Transfers the specified source buffer's data to this buffer starting at the specified absolute index.
    PacketBuffer
    setCharSequence(long index, CharSequence sequence, PacketBuffer.Charset charset)
    Writes the specified CharSequence at the current writerIndex and increases the writerIndex by the written bytes.
    PacketBuffer
    setDouble(long index, double value)
    Sets the specified 64-bit floating-point number at the specified absolute index in this buffer.
    PacketBuffer
    setDoubleRE(long index, double value)
    Sets the specified 64-bit floating-point number at the specified absolute index in this buffer in Reserved Native Endian Byte Order.
    PacketBuffer
    setFloat(long index, float value)
    Sets the specified 32-bit floating-point number at the specified absolute index in this buffer.
    PacketBuffer
    setFloatRE(long index, float value)
    Sets the specified 32-bit floating-point number at the specified absolute index in this buffer in Reserved Native Endian Byte Order.
    PacketBuffer
    setIndex(long readerIndex, long writerIndex)
    Combination of writerIndex(...) and readerIndex(...).
    PacketBuffer
    setInt(long index, int value)
    Sets the specified 32-bit integer at the specified absolute index in this buffer.
    PacketBuffer
    setIntRE(long index, int value)
    Sets the specified 32-bit integer at the specified absolute index in this buffer with Reserved Native Endian byte order .
    PacketBuffer
    setLong(long index, long value)
    Sets the specified 64-bit long integer at the specified absolute index in this buffer.
    PacketBuffer
    setLongRE(long index, long value)
    Sets the specified 64-bit long integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order.
    PacketBuffer
    setShort(long index, int value)
    Sets the specified 16-bit short integer at the specified absolute index in this buffer.
    PacketBuffer
    setShortRE(long index, int value)
    Sets the specified 16-bit short integer at the specified absolute index in this buffer with the Reserved Native Endian Byte Order.
    PacketBuffer
    skipBytes(long length)
    Increases the current readerIndex by the specified length in this buffer.
    PacketBuffer
    slice()
    Returns a slice of this buffer's readable bytes.
    PacketBuffer
    slice(long index, long length)
    Returns a slice of this buffer's sub-region.
    long
    writableBytes()
    Get readable bytes from a buffer.
    PacketBuffer
    writeBoolean(boolean value)
    Sets the specified boolean at the current writerIndex and increases the writerIndex by 1 in this buffer.
    PacketBuffer
    writeByte(int value)
    Sets the specified byte at the current writerIndex and increases the writerIndex by 1 in this buffer.
    PacketBuffer
    writeBytes(byte[] src)
    Transfers the specified source array's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= src.length).
    PacketBuffer
    writeBytes(byte[] src, long srcIndex, long length)
    Transfers the specified source array's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length).
    PacketBuffer
    writeBytes(PacketBuffer src)
    Transfers the specified source buffer's data to this buffer starting at the current writerIndex until the source buffer becomes unreadable, and increases the writerIndex by the number of the transferred bytes.
    PacketBuffer
    writeBytes(PacketBuffer src, long length)
    Transfers the specified source buffer's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length).
    PacketBuffer
    writeBytes(PacketBuffer src, long srcIndex, long length)
    Transfers the specified source buffer's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length).
    PacketBuffer
    writeCharSequence(CharSequence sequence, PacketBuffer.Charset charset)
    Writes the specified CharSequence at the current writerIndex and increases the writerIndex by the written bytes.
    PacketBuffer
    writeDouble(double value)
    Sets the specified 64-bit floating point number at the current writerIndex and increases the writerIndex by 8 in this buffer.
    PacketBuffer
    writeDoubleRE(double value)
    Sets the specified 64-bit floating point number at the current writerIndex in Reserved Native Endian Byte Order and increases the writerIndex by 8 in this buffer.
    PacketBuffer
    writeFloat(float value)
    Sets the specified 32-bit floating point number at the current writerIndex and increases the writerIndex by 4 in this buffer.
    PacketBuffer
    writeFloatRE(float value)
    Sets the specified 32-bit floating point number at the current writerIndex in Reserved Native Endian Byte Order and increases the writerIndex by 4 in this buffer.
    PacketBuffer
    writeInt(int value)
    Sets the specified 32-bit integer at the current writerIndex and increases the writerIndex by 4 in this buffer.
    PacketBuffer
    writeIntRE(int value)
    Sets the specified 32-bit integer at the current writerIndex in the Reserved Native Endian Byte Order and increases the writerIndex by 4 in this buffer.
    PacketBuffer
    writeLong(long value)
    Sets the specified 64-bit long integer at the current writerIndex and increases the writerIndex by 8 in this buffer.
    PacketBuffer
    writeLongRE(long value)
    Sets the specified 64-bit long integer at the current writerIndex in the Reserved Native Endian Byte Order and increases the writerIndex by 8 in this buffer.
    long
    writerIndex()
    Get writer buffer index.
    PacketBuffer
    writerIndex(long writerIndex)
    Sets the writerIndex of this buffer.
    PacketBuffer
    writeShort(int value)
    Sets the specified 16-bit short integer at the current writerIndex and increases the writerIndex by 2 in this buffer.
    PacketBuffer
    writeShortRE(int value)
    Sets the specified 16-bit short integer in the Reserved Native Endian Byte Order at the current writerIndex and increases the writerIndex by 2 in this buffer.

    Methods inherited from interface java.lang.AutoCloseable

    close

  • Method Details

    • capacity

      long capacity()
      Get buffer capacity.
      Returns:
      returns the number of bytes (octets) this buffer can contain.
      Since:
      1.0.0

    • capacity

      PacketBuffer capacity(long newCapacity)
      Reallocate buffer.
      Parameters:
      newCapacity - new capacity.
      Returns:
      returns new PacketBuffer.
      Since:
      1.0.0

    • readerIndex

      long readerIndex()
      Get reader buffer index.
      Returns:
      returns the readerIndex of this buffer.
      Since:
      1.0.0

    • readerIndex

      PacketBuffer readerIndex(long readerIndex)
      Sets the readerIndex of this buffer.
      Parameters:
      readerIndex - reader index.
      Returns:
      returns this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified readerIndex is less than 0 or greater than this.writerIndex
      Since:
      1.0.0

    • writerIndex

      long writerIndex()
      Get writer buffer index.
      Returns:
      returns the writerIndex of this buffer.
      Since:
      1.0.0

    • writerIndex

      PacketBuffer writerIndex(long writerIndex)
      Sets the writerIndex of this buffer.
      Parameters:
      writerIndex - writer index.
      Returns:
      returns this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified writerIndex is less than this.readerIndex or greater than this.capacity
      Since:
      1.0.0

    • setIndex

      PacketBuffer setIndex(long readerIndex, long writerIndex)
      Combination of writerIndex(...) and readerIndex(...).
      Parameters:
      readerIndex - reader index.
      writerIndex - writer index.
      Returns:
      returns this PacketBuffer.
      Since:
      1.0.0

    • readableBytes

      long readableBytes()
      Get readable bytes from a buffer.
      Returns:
      returns the number of readable bytes which is equal to (this.writerIndex - this.readerIndex).
      Since:
      1.0.0

    • writableBytes

      long writableBytes()
      Get readable bytes from a buffer.
      Returns:
      returns the number of writable bytes which is equal to (this.capacity - this.writerIndex).
      Since:
      1.0.0

    • isReadable

      boolean isReadable()
      Returns:
      returns true if and only if (this.writerIndex - this.readerIndex) is greater than 0.
      Since:
      1.0.0

    • isReadable

      boolean isReadable(long numBytes)
      Parameters:
      numBytes - number of bytes.
      Returns:
      returns true if and only if this buffer contains equal to or more than the specified number of elements.
      Since:
      1.0.0

    • isWritable

      boolean isWritable()
      Returns:
      returns true if and only if (this.capacity - this.writerIndex) is greater than 0.
      Since:
      1.0.0

    • isWritable

      boolean isWritable(long numBytes)
      Parameters:
      numBytes - number of bytes.
      Returns:
      returns true if and only if this buffer has enough room to allow writing the specified number of elements.
      Since:
      1.0.0

    • clear

      PacketBuffer clear()
      Sets the readerIndex and writerIndex of this buffer to 0. This method is identical to setIndex(0, 0).
      Returns:
      this PacketBuffer.
      Since:
      1.0.0

    • markReaderIndex

      PacketBuffer markReaderIndex()
      Marks the current readerIndex in this buffer. You can reposition the current readerIndex to the marked readerIndex by calling resetReaderIndex(). The initial value of the marked readerIndex is 0.
      Returns:
      this PacketBuffer.
      Since:
      1.0.0

    • resetReaderIndex

      PacketBuffer resetReaderIndex()
      Repositions the current readerIndex to the marked readerIndex in this buffer.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the current writerIndex is less than the marked readerIndex
      Since:
      1.0.0

    • markWriterIndex

      PacketBuffer markWriterIndex()
      Marks the current writerIndex in this buffer. You can reposition the current writerIndex to the marked writerIndex by calling resetWriterIndex(). The initial value of the marked writerIndex is 0.
      Returns:
      this PacketBuffer.
      Since:
      1.0.0

    • resetWriterIndex

      PacketBuffer resetWriterIndex()
      Repositions the current writerIndex to the marked writerIndex in this buffer.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the current readerIndex is greater than the marked writerIndex
      Since:
      1.0.0

    • ensureWritable

      PacketBuffer ensureWritable(long minWritableBytes)
      Makes sure the number of the writable bytes is equal to or greater than the specified value. If there is enough writable bytes in this buffer, this method returns with no side effect. Otherwise, it raises an IllegalArgumentException.
      Parameters:
      minWritableBytes - the expected minimum number of writable bytes
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if writerIndex() + minWritableBytes > capacity()
      Since:
      1.0.0

    • getBoolean

      boolean getBoolean(long index)
      Gets a boolean at the specified absolute (@code index) in this buffer. This method does not modify the readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      boolean value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 1 is greater than this.capacity
      Since:
      1.0.0

    • getByte

      byte getByte(long index)
      Gets a byte at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      byte value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 1 is greater than this.capacity
      Since:
      1.0.0

    • getUnsignedByte

      short getUnsignedByte(long index)
      Gets an unsigned byte at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      unsigned byte value stored in short.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 1 is greater than this.capacity
      Since:
      1.0.0

    • getShort

      short getShort(long index)
      Gets a 16-bit short integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      short value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 2 is greater than this.capacity
      Since:
      1.0.0

    • getShortRE

      short getShortRE(long index)
      Gets a 16-bit short integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      reserved native endian short value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 2 is greater than this.capacity
      Since:
      1.0.0

    • getUnsignedShort

      int getUnsignedShort(long index)
      Gets an unsigned 16-bit short integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      unsigned short value stored in integer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 2 is greater than this.capacity
      Since:
      1.0.0

    • getUnsignedShortRE

      int getUnsignedShortRE(long index)
      Gets an unsigned 16-bit short integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      unsigned reserved native endian short value stored in integer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 2 is greater than this.capacity
      Since:
      1.0.0

    • getInt

      int getInt(long index)
      Gets a 32-bit integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      integer value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • getIntRE

      int getIntRE(long index)
      Gets a 32-bit integer at the specified absolute index in this buffer with Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      reserved native endian integer value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • getUnsignedInt

      long getUnsignedInt(long index)
      Gets an unsigned 32-bit integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      unsigned integer value stored in long.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • getUnsignedIntRE

      long getUnsignedIntRE(long index)
      Gets an unsigned 32-bit integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      unsigned reserved native endian integer value stored in long.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • getLong

      long getLong(long index)
      Gets a 64-bit long integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      long value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 8 is greater than this.capacity
      Since:
      1.0.0

    • getLongRE

      long getLongRE(long index)
      Gets a 64-bit long integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      reserved native endian long value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 8 is greater than this.capacity
      Since:
      1.0.0

    • getFloat

      float getFloat(long index)
      Gets a 32-bit floating point number at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      float value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • getFloatRE

      float getFloatRE(long index)
      Gets a 32-bit floating point number at the specified absolute index in this buffer in Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      reserved native endian float value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • getDouble

      double getDouble(long index)
      Gets a 64-bit floating point number at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      double value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 8 is greater than this.capacity
      Since:
      1.0.0

    • getDoubleRE

      double getDoubleRE(long index)
      Gets a 64-bit floating point number at the specified absolute index in this buffer in Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      Returns:
      reserved native endian double value.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 8 is greater than this.capacity
      Since:
      1.0.0

    • getBytes

      PacketBuffer getBytes(long index, PacketBuffer dst)
      Transfers this buffer's data to the specified destination starting at the specified absolute index until the destination becomes non-writable. This method is basically same with getBytes(long, PacketBuffer, long, long), except that this method increases the writerIndex of the destination by the number of the transferred bytes while getBytes(long, PacketBuffer, long, long) does not. This method does not modify readerIndex or writerIndex of the source buffer (i.e. this).
      Parameters:
      index - index.
      dst - destination.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or if index + dst.writableBytes is greater than this.capacity
      Since:
      1.0.0

    • getBytes

      PacketBuffer getBytes(long index, PacketBuffer dst, long length)
      Transfers this buffer's data to the specified destination starting at the specified absolute index. This method is basically same with getBytes(long, PacketBuffer, long, long), except that this method increases the writerIndex of the destination by the number of the transferred bytes while getBytes(long, PacketBuffer, long, long) does not. This method does not modify readerIndex or writerIndex of the source buffer (i.e. this).
      Parameters:
      index - index.
      dst - destination.
      length - the number of bytes to transfer
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0, if index + length is greater than this.capacity, or if length is greater than dst.writableBytes
      Since:
      1.0.0

    • getBytes

      PacketBuffer getBytes(long index, PacketBuffer dst, long dstIndex, long length)
      Transfers this buffer's data to the specified destination starting at the specified absolute index. This method does not modify readerIndex or writerIndex of both the source (i.e. this) and the destination.
      Parameters:
      index - index.
      dst - destination.
      dstIndex - the first index of the destination
      length - the number of bytes to transfer
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0, if the specified dstIndex is less than 0, if index + length is greater than this.capacity, or if dstIndex + length is greater than dst.capacity
      Since:
      1.0.0

    • getBytes

      PacketBuffer getBytes(long index, byte[] dst)
      Transfers this buffer's data to the specified destination starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer
      Parameters:
      index - index.
      dst - destination.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or if index + dst.length is greater than this.capacity
      Since:
      1.0.0

    • getBytes

      PacketBuffer getBytes(long index, byte[] dst, long dstIndex, long length)
      Transfers this buffer's data to the specified destination starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      dst - destination.
      dstIndex - the first index of the destination
      length - the number of bytes to transfer
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0, if the specified dstIndex is less than 0, if index + length is greater than this.capacity, or if dstIndex + length is greater than dst.length
      Since:
      1.0.0

    • getCharSequence

      CharSequence getCharSequence(long index, long length, PacketBuffer.Charset charset)
      Gets a CharSequence with the given length at the given index.
      Parameters:
      index - index.
      length - the length to read
      charset - that should be used
      Returns:
      a string from buffer.
      Throws:
      IndexOutOfBoundsException - if length is greater than this.readableBytes
      Since:
      1.0.0

    • setBoolean

      PacketBuffer setBoolean(long index, boolean value)
      Sets the specified boolean at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 1 is greater than this.capacity
      Since:
      1.0.0

    • setByte

      PacketBuffer setByte(long index, int value)
      Sets the specified byte at the specified absolute index in this buffer. The 24 high-order bits of the specified value are ignored. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 1 is greater than this.capacity
      Since:
      1.0.0

    • setShort

      PacketBuffer setShort(long index, int value)
      Sets the specified 16-bit short integer at the specified absolute index in this buffer. The 16 high-order bits of the specified value are ignored. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 2 is greater than this.capacity
      Since:
      1.0.0

    • setShortRE

      PacketBuffer setShortRE(long index, int value)
      Sets the specified 16-bit short integer at the specified absolute index in this buffer with the Reserved Native Endian Byte Order. The 16 high-order bits of the specified value are ignored. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 2 is greater than this.capacity
      Since:
      1.0.0

    • setInt

      PacketBuffer setInt(long index, int value)
      Sets the specified 32-bit integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • setIntRE

      PacketBuffer setIntRE(long index, int value)
      Sets the specified 32-bit integer at the specified absolute index in this buffer with Reserved Native Endian byte order . This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • setLong

      PacketBuffer setLong(long index, long value)
      Sets the specified 64-bit long integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 8 is greater than this.capacity
      Since:
      1.0.0

    • setLongRE

      PacketBuffer setLongRE(long index, long value)
      Sets the specified 64-bit long integer at the specified absolute index in this buffer in Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 8 is greater than this.capacity
      Since:
      1.0.0

    • setFloat

      PacketBuffer setFloat(long index, float value)
      Sets the specified 32-bit floating-point number at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • setFloatRE

      PacketBuffer setFloatRE(long index, float value)
      Sets the specified 32-bit floating-point number at the specified absolute index in this buffer in Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 4 is greater than this.capacity
      Since:
      1.0.0

    • setDouble

      PacketBuffer setDouble(long index, double value)
      Sets the specified 64-bit floating-point number at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 8 is greater than this.capacity
      Since:
      1.0.0

    • setDoubleRE

      PacketBuffer setDoubleRE(long index, double value)
      Sets the specified 64-bit floating-point number at the specified absolute index in this buffer in Reserved Native Endian Byte Order. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or index + 8 is greater than this.capacity
      Since:
      1.0.0

    • setBytes

      PacketBuffer setBytes(long index, PacketBuffer src)
      Transfers the specified source buffer's data to this buffer starting at the specified absolute index until the source buffer becomes unreadable. This method is basically same with setBytes(long, PacketBuffer, long, long), except that this method increases the readerIndex of the source buffer by the number of the transferred bytes while setBytes(long, PacketBuffer, long, long) does not. This method does not modify readerIndex or writerIndex of the source buffer (i.e. this).
      Parameters:
      index - index.
      src - source.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or if index + src.readableBytes is greater than this.capacity
      Since:
      1.0.0

    • setBytes

      PacketBuffer setBytes(long index, PacketBuffer src, long length)
      Transfers the specified source buffer's data to this buffer starting at the specified absolute index. This method is basically same with setBytes(long, PacketBuffer, long, long), except that this method increases the readerIndex of the source buffer by the number of the transferred bytes while setBytes(long, PacketBuffer, long, long) does not. This method does not modify readerIndex or writerIndex of the source buffer (i.e. this).
      Parameters:
      index - index.
      src - source.
      length - the number of bytes to transfer
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0, if index + length is greater than this.capacity, or if length is greater than src.readableBytes
      Since:
      1.0.0

    • setBytes

      PacketBuffer setBytes(long index, PacketBuffer src, long srcIndex, long length)
      Transfers the specified source buffer's data to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of both the source (i.e. this) and the destination.
      Parameters:
      index - index.
      src - source.
      srcIndex - the first index of the source
      length - the number of bytes to transfer
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0, if the specified srcIndex is less than 0, if index + length is greater than this.capacity, or if srcIndex + length is greater than src.capacity
      Since:
      1.0.0

    • setBytes

      PacketBuffer setBytes(long index, byte[] src)
      Transfers the specified source array's data to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      src - source.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0 or if index + src.length is greater than this.capacity
      Since:
      1.0.0

    • setBytes

      PacketBuffer setBytes(long index, byte[] src, long srcIndex, long length)
      Transfers the specified source array's data to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      src - source.
      srcIndex - source index.
      length - length.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified index is less than 0, if the specified srcIndex is less than 0, if index + length is greater than this.capacity, or if srcIndex + length is greater than src.length
      Since:
      1.0.0

    • setCharSequence

      PacketBuffer setCharSequence(long index, CharSequence sequence, PacketBuffer.Charset charset)
      Writes the specified CharSequence at the current writerIndex and increases the writerIndex by the written bytes.
      Parameters:
      index - on which the sequence should be written.
      sequence - to write.
      charset - that should be used.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is not large enough to write the whole sequence
      Since:
      1.0.0

    • readBoolean

      boolean readBoolean()
      Gets a boolean at the current readerIndex and increases the readerIndex by 1 in this buffer.
      Returns:
      boolean value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 1
      Since:
      1.0.0

    • readByte

      byte readByte()
      Gets a byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
      Returns:
      byte value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 1
      Since:
      1.0.0

    • readUnsignedByte

      short readUnsignedByte()
      Gets an unsigned byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
      Returns:
      unsigned byte stored in short.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 1
      Since:
      1.0.0

    • readShort

      short readShort()
      Gets a 16-bit short integer at the current readerIndex and increases the readerIndex by 2 in this buffer.
      Returns:
      short value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 2
      Since:
      1.0.0

    • readShortRE

      short readShortRE()
      Gets a 16-bit short integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 2 in this buffer.
      Returns:
      reserved native endian short value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 2
      Since:
      1.0.0

    • readUnsignedShort

      int readUnsignedShort()
      Gets an unsigned 16-bit short integer at the current readerIndex and increases the readerIndex by 2 in this buffer.
      Returns:
      unsigned short value stored in integer.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 2
      Since:
      1.0.0

    • readUnsignedShortRE

      int readUnsignedShortRE()
      Gets an unsigned 16-bit short integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 2 in this buffer.
      Returns:
      unsigned reserved native endian short value stored in integer.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 2
      Since:
      1.0.0

    • readInt

      int readInt()
      Gets a 32-bit integer at the current readerIndex and increases the readerIndex by 4 in this buffer.
      Returns:
      integer value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 4
      Since:
      1.0.0

    • readIntRE

      int readIntRE()
      Gets a 32-bit integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 4 in this buffer.
      Returns:
      reserved native endian integer value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 4
      Since:
      1.0.0

    • readUnsignedInt

      long readUnsignedInt()
      Gets an unsigned 32-bit integer at the current readerIndex and increases the readerIndex by 4 in this buffer.
      Returns:
      unsigned integer value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 4
      Since:
      1.0.0

    • readUnsignedIntRE

      long readUnsignedIntRE()
      Gets an unsigned 32-bit integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 4 in this buffer.
      Returns:
      unsigned reserved native endian integer value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 4
      Since:
      1.0.0

    • readLong

      long readLong()
      Gets a 64-bit integer at the current readerIndex and increases the readerIndex by 8 in this buffer.
      Returns:
      long value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 8
      Since:
      1.0.0

    • readLongRE

      long readLongRE()
      Gets a 64-bit integer at the current readerIndex in the Reserved Native Endian Byte Order and increases the readerIndex by 8 in this buffer.
      Returns:
      reserved native endian long value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 8
      Since:
      1.0.0

    • readFloat

      float readFloat()
      Gets a 32-bit floating point number at the current readerIndex and increases the readerIndex by 4 in this buffer.
      Returns:
      float value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 4
      Since:
      1.0.0

    • readFloatRE

      float readFloatRE()
      Gets a 32-bit floating point number at the current readerIndex in Reserved Native Endian Byte Order and increases the readerIndex by 4 in this buffer.
      Returns:
      reserved native endian float value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 4
      Since:
      1.0.0

    • readDouble

      double readDouble()
      Gets a 64-bit floating point number at the current readerIndex and increases the readerIndex by 8 in this buffer.
      Returns:
      double value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 8
      Since:
      1.0.0

    • readDoubleRE

      double readDoubleRE()
      Gets a 64-bit floating point number at the current readerIndex in Reserved Native Endian Byte Order and increases the readerIndex by 8 in this buffer.
      Returns:
      reserved native endian double value.
      Throws:
      IndexOutOfBoundsException - if this.readableBytes is less than 8
      Since:
      1.0.0

    • readBytes

      PacketBuffer readBytes(PacketBuffer dst)
      Transfers this buffer's data to the specified destination starting at the current readerIndex until the destination becomes non-writable, and increases the readerIndex by the number of the transferred bytes. This method is basically same with readBytes(PacketBuffer, long, long), except that this method increases the writerIndex of the destination by the number of the transferred bytes while readBytes(PacketBuffer, long, long) does not.
      Parameters:
      dst - destination.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if dst.writableBytes is greater than this.readableBytes
      Since:
      1.0.0

    • readBytes

      PacketBuffer readBytes(PacketBuffer dst, long length)
      Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length). This method is basically same with readBytes(PacketBuffer, long, long), except that this method increases the writerIndex of the destination by the number of the transferred bytes (= length) while readBytes(PacketBuffer, long, long) does not.
      Parameters:
      dst - destination.
      length - length.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if length is greater than this.readableBytes or if length is greater than dst.writableBytes
      Since:
      1.0.0

    • readBytes

      PacketBuffer readBytes(PacketBuffer dst, long dstIndex, long length)
      Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
      Parameters:
      dst - destination.
      dstIndex - the first index of the destination
      length - the number of bytes to transfer
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified dstIndex is less than 0, if length is greater than this.readableBytes, or if dstIndex + length is greater than dst.capacity
      Since:
      1.0.0

    • readBytes

      PacketBuffer readBytes(byte[] dst)
      Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= dst.length).
      Parameters:
      dst - destination.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if dst.length is greater than this.readableBytes
      Since:
      1.0.0

    • readBytes

      PacketBuffer readBytes(byte[] dst, long dstIndex, long length)
      Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
      Parameters:
      dst - destination.
      dstIndex - the first index of the destination
      length - the number of bytes to transfer
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified dstIndex is less than 0, if length is greater than this.readableBytes, or if dstIndex + length is greater than dst.length
      Since:
      1.0.0

    • skipBytes

      PacketBuffer skipBytes(long length)
      Increases the current readerIndex by the specified length in this buffer.
      Parameters:
      length - length.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if length is greater than this.readableBytes
      Since:
      1.0.0

    • readCharSequence

      CharSequence readCharSequence(long length, PacketBuffer.Charset charset)
      Gets a CharSequence with the given length at the current readerIndex and increases the readerIndex by the given length.
      Parameters:
      length - the length to read
      charset - that should be used
      Returns:
      the char sequence.
      Throws:
      IndexOutOfBoundsException - if length is greater than this.readableBytes
      Since:
      1.0.0

    • writeBoolean

      PacketBuffer writeBoolean(boolean value)
      Sets the specified boolean at the current writerIndex and increases the writerIndex by 1 in this buffer.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 1
      Since:
      1.0.0

    • writeByte

      PacketBuffer writeByte(int value)
      Sets the specified byte at the current writerIndex and increases the writerIndex by 1 in this buffer. The 24 high-order bits of the specified value are ignored.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 1
      Since:
      1.0.0

    • writeShort

      PacketBuffer writeShort(int value)
      Sets the specified 16-bit short integer at the current writerIndex and increases the writerIndex by 2 in this buffer. The 16 high-order bits of the specified value are ignored.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 2
      Since:
      1.0.0

    • writeShortRE

      PacketBuffer writeShortRE(int value)
      Sets the specified 16-bit short integer in the Reserved Native Endian Byte Order at the current writerIndex and increases the writerIndex by 2 in this buffer. The 16 high-order bits of the specified value are ignored.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 2
      Since:
      1.0.0

    • writeInt

      PacketBuffer writeInt(int value)
      Sets the specified 32-bit integer at the current writerIndex and increases the writerIndex by 4 in this buffer.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 4
      Since:
      1.0.0

    • writeIntRE

      PacketBuffer writeIntRE(int value)
      Sets the specified 32-bit integer at the current writerIndex in the Reserved Native Endian Byte Order and increases the writerIndex by 4 in this buffer.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 4
      Since:
      1.0.0

    • writeLong

      PacketBuffer writeLong(long value)
      Sets the specified 64-bit long integer at the current writerIndex and increases the writerIndex by 8 in this buffer.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 8
      Since:
      1.0.0

    • writeLongRE

      PacketBuffer writeLongRE(long value)
      Sets the specified 64-bit long integer at the current writerIndex in the Reserved Native Endian Byte Order and increases the writerIndex by 8 in this buffer.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 8
      Since:
      1.0.0

    • writeFloat

      PacketBuffer writeFloat(float value)
      Sets the specified 32-bit floating point number at the current writerIndex and increases the writerIndex by 4 in this buffer.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 4
      Since:
      1.0.0

    • writeFloatRE

      PacketBuffer writeFloatRE(float value)
      Sets the specified 32-bit floating point number at the current writerIndex in Reserved Native Endian Byte Order and increases the writerIndex by 4 in this buffer.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 4
      Since:
      1.0.0

    • writeDouble

      PacketBuffer writeDouble(double value)
      Sets the specified 64-bit floating point number at the current writerIndex and increases the writerIndex by 8 in this buffer.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 8
      Since:
      1.0.0

    • writeDoubleRE

      PacketBuffer writeDoubleRE(double value)
      Sets the specified 64-bit floating point number at the current writerIndex in Reserved Native Endian Byte Order and increases the writerIndex by 8 in this buffer.
      Parameters:
      value - value.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is less than 8
      Since:
      1.0.0

    • writeBytes

      PacketBuffer writeBytes(PacketBuffer src)
      Transfers the specified source buffer's data to this buffer starting at the current writerIndex until the source buffer becomes unreadable, and increases the writerIndex by the number of the transferred bytes. This method is basically same with writeBytes(PacketBuffer, long, long), except that this method increases the readerIndex of the source buffer by the number of the transferred bytes while writeBytes(PacketBuffer, long, long) does not.
      Parameters:
      src - source.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if src.readableBytes is greater than this.writableBytes
      Since:
      1.0.0

    • writeBytes

      PacketBuffer writeBytes(PacketBuffer src, long length)
      Transfers the specified source buffer's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length). This method is basically same with writeBytes(PacketBuffer, long, long), except that this method increases the readerIndex of the source buffer by the number of the transferred bytes (= length) while writeBytes(PacketBuffer, long, long) does not.
      Parameters:
      src - source.
      length - the number of bytes to transfer.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if length is greater than this.writableBytes or if length is greater then src.readableBytes
      Since:
      1.0.0

    • writeBytes

      PacketBuffer writeBytes(PacketBuffer src, long srcIndex, long length)
      Transfers the specified source buffer's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length).
      Parameters:
      src - source.
      srcIndex - the first index of the source
      length - the number of bytes to transfer
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified srcIndex is less than 0, if srcIndex + length is greater than src.capacity, or if length is greater than this.writableBytes
      Since:
      1.0.0

    • writeBytes

      PacketBuffer writeBytes(byte[] src)
      Transfers the specified source array's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= src.length).
      Parameters:
      src - source.
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if src.length is greater than this.writableBytes
      Since:
      1.0.0

    • writeBytes

      PacketBuffer writeBytes(byte[] src, long srcIndex, long length)
      Transfers the specified source array's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length).
      Parameters:
      src - source.
      srcIndex - the first index of the source
      length - the number of bytes to transfer
      Returns:
      this PacketBuffer.
      Throws:
      IndexOutOfBoundsException - if the specified srcIndex is less than 0, if srcIndex + length is greater than src.length, or if length is greater than this.writableBytes
      Since:
      1.0.0

    • writeCharSequence

      PacketBuffer writeCharSequence(CharSequence sequence, PacketBuffer.Charset charset)
      Writes the specified CharSequence at the current writerIndex and increases the writerIndex by the written bytes. in this buffer.
      Parameters:
      sequence - to write.
      charset - that should be used.
      Returns:
      the written number of bytes.
      Throws:
      IndexOutOfBoundsException - if this.writableBytes is not large enough to write the whole sequence
      Since:
      1.0.0

    • copy

      PacketBuffer copy()
      Returns a copy of this buffer's readable bytes. Modifying the content of the returned buffer or this buffer does not affect each other at all. This method is identical to copy(readerIndex(), readableBytes()). This method does not modify readerIndex or writerIndex of this buffer.
      Returns:
      copied PacketBuffer buffer's.
      Since:
      1.0.0

    • copy

      PacketBuffer copy(long index, long length)
      Returns a copy of this buffer's sub-region. Modifying the content of the returned buffer or this buffer does not affect each other at all. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      length - length.
      Returns:
      copied PacketBuffer buffer's.
      Since:
      1.0.0

    • slice

      PacketBuffer slice()
      Returns a slice of this buffer's readable bytes. Modifying the content of the returned buffer or this buffer affects each other's content while they maintain separate indexes and marks. This method is identical to slice(readerIndex(), readableBytes()). This method does not modify readerIndex or writerIndex of this buffer.
      Returns:
      returns sliced PacketBuffer buffer's.
      Since:
      1.0.0

    • slice

      PacketBuffer slice(long index, long length)
      Returns a slice of this buffer's sub-region. Modifying the content of the returned buffer or this buffer affects each other's content while they maintain separate indexes and marks. This method does not modify readerIndex or writerIndex of this buffer.
      Parameters:
      index - index.
      length - length.
      Returns:
      returns sliced PacketBuffer buffer's.
      Since:
      1.0.0

    • duplicate

      PacketBuffer duplicate()
      Duplicate the this PacketBuffer buffer. Modifying the content of the returned buffer or this buffer affects each other's content while they maintain separate indexes and marks
      Returns:
      returns duplicated PacketBuffer.
      Since:
      1.0.0

    • byteOrder

      PacketBuffer.ByteOrder byteOrder()
      Retrieves this buffer's native byte order.
      Returns:
      returns PacketBuffer.ByteOrder.BIG_ENDIAN or PacketBuffer.ByteOrder.LITTLE_ENDIAN.
      Since:
      1.0.0

    • byteOrder

      PacketBuffer byteOrder(PacketBuffer.ByteOrder byteOrder)
      Change this buffer's byte order.
      Parameters:
      byteOrder - byte order.
      Returns:
      returns this buffer's with new byte order.
      Since:
      1.0.0

    • memoryAddress

      long memoryAddress() throws IllegalAccessException
      Get the first byte memory address of this PacketBuffer.
      Returns:
      returns first byte memory address.
      Throws:
      IllegalAccessException - restricted function call.
      Since:
      1.3.1

    • release

      boolean release()
      Release this PacketBuffer buffer
      Returns:
      returns true on sucess, false otherwise.
      Since:
      1.0.0

    • cast

      <T extends Packet.Abstract> T cast(Class<T> t)
      Casting buffer to Packet.
      Type Parameters:
      T - type.
      Parameters:
      t - packet type.
      Returns:
      returns Packet.