Module org.glassfish.grizzly
Package org.glassfish.grizzly.memory

Class HeapBuffer

java.lang.Object
org.glassfish.grizzly.memory.HeapBuffer
All Implemented Interfaces:
Comparable<Buffer>, WritableMessage, Buffer
public class HeapBuffer extends Object implements Buffer
Buffer implementation, which uses the ByteBuffer underneath.
Since:
2.0
Author:
Ken Cavanaugh, John Vieten, Alexey Stashok, Ryan Lubke
See Also:

  • Field Details

    • DEBUG_MODE

      public static volatile boolean DEBUG_MODE

    • allowBufferDispose

      protected boolean allowBufferDispose

    • disposeStackTrace

      protected Exception disposeStackTrace

    • heap

      protected byte[] heap

    • offset

      protected int offset

    • pos

      protected int pos

    • cap

      protected int cap

    • lim

      protected int lim

    • mark

      protected int mark

    • readOnly

      protected boolean readOnly

    • order

      protected ByteOrder order

    • bigEndian

      protected boolean bigEndian

    • byteBuffer

      protected ByteBuffer byteBuffer

  • Constructor Details

    • HeapBuffer

      protected HeapBuffer()

    • HeapBuffer

      protected HeapBuffer(byte[] heap, int offset, int cap)

  • Method Details

    • isComposite

      public final boolean isComposite()
      Specified by:
      isComposite in interface Buffer
      Returns:
      true if this Buffer represents a composite of individual Buffer instances.

    • prepend

      public HeapBuffer prepend(Buffer header)
      Description copied from interface: Buffer
      Prepend data from header.position() to header.limit() to the current buffer. This will change the value returned by buffer()!
      Specified by:
      prepend in interface Buffer
      Parameters:
      header - the data to prepend
      Returns:
      the new buffer

    • trim

      public void trim()
      Description copied from interface: Buffer
      Trim the buffer by reducing capacity to position, if possible. May return without changing capacity. Also resets the position to 0, like Buffer.flip().
      Specified by:
      trim in interface Buffer

    • shrink

      public void shrink()
      Description copied from interface: Buffer
      Disposes the buffer part, outside [position, limit] interval if possible. May return without changing capacity. After shrink is called, position/limit/capacity values may have different values, than before, but still point to the same Buffer elements.
      Specified by:
      shrink in interface Buffer

    • allowBufferDispose

      public final boolean allowBufferDispose()
      Specified by:
      allowBufferDispose in interface Buffer

    • allowBufferDispose

      public final void allowBufferDispose(boolean allowBufferDispose)
      Specified by:
      allowBufferDispose in interface Buffer

    • tryDispose

      public final boolean tryDispose()
      Description copied from interface: Buffer
      Try to dispose Buffer if it's allowed.
      Specified by:
      tryDispose in interface Buffer
      Returns:
      true if successfully disposed

    • dispose

      public void dispose()
      Description copied from interface: Buffer
      Notify the allocator that the space for this Buffer is no longer needed. All calls to methods on a Buffer will fail after a call to dispose().
      Specified by:
      dispose in interface Buffer

    • prepareDispose

      protected final void prepareDispose()

    • underlying

      public ByteBuffer underlying()
      Description copied from interface: Buffer
      Return the underlying buffer
      Specified by:
      underlying in interface Buffer
      Returns:
      the underlying buffer

    • capacity

      public final int capacity()
      Description copied from interface: Buffer
      Returns this buffer's capacity.
      Specified by:
      capacity in interface Buffer
      Returns:
      The capacity of this buffer

    • position

      public final int position()
      Description copied from interface: Buffer
      Returns this buffer's position.
      Specified by:
      position in interface Buffer
      Returns:
      The position of this buffer

    • position

      public final HeapBuffer position(int newPosition)
      Description copied from interface: Buffer
      Sets this buffer's position. If the mark is defined and larger than the new position then it is discarded.
      Specified by:
      position in interface Buffer
      Parameters:
      newPosition - The new position value; must be non-negative and no larger than the current limit
      Returns:
      This buffer

    • limit

      public final int limit()
      Description copied from interface: Buffer
      Returns this buffer's limit.
      Specified by:
      limit in interface Buffer
      Returns:
      The limit of this buffer

    • limit

      public final HeapBuffer limit(int newLimit)
      Description copied from interface: Buffer
      Sets this buffer's limit. If the position is larger than the new limit then it is set to the new limit. If the mark is defined and larger than the new limit then it is discarded.
      Specified by:
      limit in interface Buffer
      Parameters:
      newLimit - The new limit value; must be non-negative and no larger than this buffer's capacity
      Returns:
      This buffer

    • mark

      public final HeapBuffer mark()
      Description copied from interface: Buffer
      Sets this buffer's mark at its position.
      Specified by:
      mark in interface Buffer
      Returns:
      This buffer

    • reset

      public final HeapBuffer reset()
      Description copied from interface: Buffer
      Resets this buffer's position to the previously-marked position.

      Invoking this method neither changes nor discards the mark's value.

      Specified by:
      reset in interface Buffer
      Returns:
      This buffer

    • clear

      public final HeapBuffer clear()
      Description copied from interface: Buffer
      Clears this buffer. The position is set to zero, the limit is set to the capacity, and the mark is discarded.

      Invoke this method before using a sequence of channel-read or put operations to fill this buffer. For example: 

       buf.clear(); // Prepare buffer for reading
 in.read(buf); // Read data

      This method does not actually erase the data in the buffer, but it is named as if it did because it will most often be used in situations in which that might as well be the case.

      Specified by:
      clear in interface Buffer
      Returns:
      This buffer

    • flip

      public final HeapBuffer flip()
      Description copied from interface: Buffer
      Flips this buffer. The limit is set to the current position and then the position is set to zero. If the mark is defined then it is discarded.

      After a sequence of channel-read or put operations, invoke this method to prepare for a sequence of channel-write or relative get operations. For example: 

       buf.put(magic); // Prepend header
 in.read(buf); // Read data into rest of buffer
 buf.flip(); // Flip buffer
 out.write(buf); // Write header + data to channel

      This method is often used in conjunction with the compact method when transferring data from one place to another.

      Specified by:
      flip in interface Buffer
      Returns:
      This buffer

    • rewind

      public final HeapBuffer rewind()
      Description copied from interface: Buffer
      Rewinds this buffer. The position is set to zero and the mark is discarded.

      Invoke this method before a sequence of channel-write or get operations, assuming that the limit has already been set appropriately. For example: 

       out.write(buf); // Write remaining data
 buf.rewind(); // Rewind buffer
 buf.get(array); // Copy data into array
      Specified by:
      rewind in interface Buffer
      Returns:
      This buffer

    • remaining

      public final int remaining()
      Description copied from interface: Buffer
      Returns the number of elements between the current position and the limit.
      Specified by:
      remaining in interface Buffer
      Specified by:
      remaining in interface WritableMessage
      Returns:
      The number of elements remaining in this buffer

    • hasRemaining

      public final boolean hasRemaining()
      Description copied from interface: Buffer
      Tells whether there are any elements between the current position and the limit.
      Specified by:
      hasRemaining in interface Buffer
      Specified by:
      hasRemaining in interface WritableMessage
      Returns:
      true if, and only if, there is at least one element remaining in this buffer

    • isReadOnly

      public boolean isReadOnly()
      Description copied from interface: Buffer
      Tells whether or not this buffer is read-only.
      Specified by:
      isReadOnly in interface Buffer
      Returns:
      true if, and only if, this buffer is read-only

    • isDirect

      public final boolean isDirect()
      Description copied from interface: Buffer
      Tells whether or not this buffer is direct.
      Specified by:
      isDirect in interface Buffer
      Returns:
      true if, and only if, this buffer is direct

    • split

      public Buffer split(int splitPosition)
      Split up the buffer into two parts: [0..splitPosition) and [splitPosition, capacity). This Buffer will represent the first part: [0..splitPosition) and returned Buffer will represent the second part: [splitPosition, capacity). Splitting a buffer will reset the mark if the mark is greater than or equal to the splitPosition.
      Specified by:
      split in interface Buffer
      Parameters:
      splitPosition - position of split.
      Returns:
      the Buffer, which represents split part [splitPosition, capacity)

    • slice

      public HeapBuffer slice()
      Description copied from interface: Buffer
      Creates a new Buffer whose content is a shared subsequence of this buffer's content.

      The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

      The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

      Specified by:
      slice in interface Buffer
      Returns:
      The new Buffer

    • slice

      public HeapBuffer slice(int position, int limit)
      Description copied from interface: Buffer
      Creates a new Buffer whose content is a shared subsequence of this buffer's content.

      The content of the new buffer will start at passed position and end at passed limit. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffer's position, limit, and mark values will be independent.

      The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

      Specified by:
      slice in interface Buffer
      Parameters:
      position - the position of the start of the slice
      limit - the limit to take the slice up to
      Returns:
      The new Buffer

    • duplicate

      public HeapBuffer duplicate()
      Description copied from interface: Buffer
      Creates a new Buffer that shares this buffer's content.

      The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffer's position, limit, and mark values will be independent.

      The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

      Specified by:
      duplicate in interface Buffer
      Returns:
      The new Buffer

    • asReadOnlyBuffer

      public HeapBuffer asReadOnlyBuffer()
      Description copied from interface: Buffer
      Creates a new, read-only Buffer that shares this buffer's content.

      The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffer's position, limit, and mark values will be independent.

      The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.

      If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate method.

      Specified by:
      asReadOnlyBuffer in interface Buffer
      Returns:
      The new, read-only Buffer

    • get

      public byte get()
      Description copied from interface: Buffer
      Relative get method. Reads the byte at this buffer's current position, and then increments the position.
      Specified by:
      get in interface Buffer
      Returns:
      The byte at the buffer's current position

    • get

      public byte get(int index)
      Description copied from interface: Buffer
      Absolute get method. Reads the byte at the given index.
      Specified by:
      get in interface Buffer
      Parameters:
      index - The index from which the byte will be read
      Returns:
      The byte at the given index

    • put

      public HeapBuffer put(byte b)
      Description copied from interface: Buffer
      Relative put method  (optional operation).

      Writes the given byte into this buffer at the current position, and then increments the position.

      Specified by:
      put in interface Buffer
      Parameters:
      b - The byte to be written
      Returns:
      This buffer

    • put

      public HeapBuffer put(int index, byte b)
      Description copied from interface: Buffer
      Absolute put method  (optional operation).

      Writes the given byte into this buffer at the given index.

      Specified by:
      put in interface Buffer
      Parameters:
      index - The index at which the byte will be written
      b - The byte value to be written
      Returns:
      This buffer

    • get

      public HeapBuffer get(byte[] dst)
      Description copied from interface: Buffer
      Relative bulk get method.

      This method transfers bytes from this buffer into the given destination array. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation 

       src.get(a, 0, a.length)
      Specified by:
      get in interface Buffer
      Parameters:
      dst - destination array to put the bytes into
      Returns:
      This buffer

    • get

      public HeapBuffer get(byte[] dst, int offset, int length)
      Description copied from interface: Buffer
      Relative bulk get method.

      This method transfers bytes from this buffer into the given destination array. If there are fewer bytes remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no bytes are transferred and a BufferUnderflowException is thrown.

      Otherwise, this method copies length bytes from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

      In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop 

       for (int i = off; i < off + len; i++)
     dst[i] = src.get();
      except that it first checks that there are sufficient bytes in this buffer and it is potentially much more efficient.
      Specified by:
      get in interface Buffer
      Parameters:
      dst - The array into which bytes are to be written
      offset - The offset within the array of the first byte to be written; must be non-negative and no larger than dst.length
      length - The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.length - offset
      Returns:
      This buffer

    • put

      public HeapBuffer put(Buffer src)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the bytes remaining in the given source buffer into this buffer. If there are more bytes remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies n = src.remaining() bytes from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

      In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop 

       while (src.hasRemaining())
     dst.put(src.get());
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Specified by:
      put in interface Buffer
      Parameters:
      src - The source buffer from which bytes are to be read; must not be this buffer
      Returns:
      This buffer

    • put

      public HeapBuffer put(Buffer src, int position, int length)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the "length" bytes from the given source buffer into this buffer. If this buffer has less bytes remaining than length, that is, if length > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies n = length bytes from the given position in the source buffer into this buffer, starting from the current buffer position. The positions of this buffer is then incremented by length.

      In other words, an invocation of this method of the form dst.put(src, position, length) has exactly the same effect as the loop 

       for (int i = 0; i < length; i++)
     dst.put(src.get(i + position));
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Specified by:
      put in interface Buffer
      Parameters:
      src - The source buffer from which bytes are to be read; must not be this buffer
      position - starting position in the source buffer
      length - number of bytes to be copied
      Returns:
      This buffer

    • get

      public Buffer get(ByteBuffer dst)
      Description copied from interface: Buffer
      Relative bulk get method.

      This method transfers bytes from this buffer into the given destination ByteBuffer. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation 

       src.get(a, 0, a.remaining())
      Specified by:
      get in interface Buffer
      Parameters:
      dst - destination ByteBuffer to put the data into
      Returns:
      This buffer

    • get

      public Buffer get(ByteBuffer dst, int position, int length)
      Description copied from interface: Buffer
      Relative bulk get method.

      This method transfers bytes from this buffer into the given destination ByteBuffer. If there are fewer bytes remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no bytes are transferred and a BufferUnderflowException is thrown.

      Otherwise, this method copies length bytes from this buffer into the given ByteBuffer, starting at the current position of this buffer and at the given offset in the ByteBuffer. The position of this buffer is then incremented by length.

      In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop 

       for (int i = off; i < off + len; i++)
     dst.put(i) = src.get();
      except that it first checks that there are sufficient bytes in this buffer and it is potentially much more efficient.
      Specified by:
      get in interface Buffer
      Parameters:
      dst - The ByteBuffer into which bytes are to be written
      position - The offset within the ByteBuffer of the first byte to be written; must be non-negative and no larger than dst.remaining()
      length - The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.remaining() - offset
      Returns:
      This buffer

    • put

      public Buffer put(ByteBuffer src)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the bytes remaining in the given source buffer into this buffer. If there are more bytes remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies n = src.remaining() bytes from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

      In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop 

       while (src.hasRemaining())
     dst.put(src.get());
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Specified by:
      put in interface Buffer
      Parameters:
      src - The source buffer from which bytes are to be read; must not be this buffer
      Returns:
      This buffer

    • put

      public Buffer put(ByteBuffer src, int position, int length)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the "length" bytes from the given source buffer into this buffer. If this buffer has less bytes remaining than length, that is, if length > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies n = length bytes from the given position in the source buffer into this buffer, starting from the current buffer position. The positions of this buffer is then incremented by length.

      In other words, an invocation of this method of the form dst.put(src, position, length) has exactly the same effect as the loop 

       for (int i = 0; i < length; i++)
     dst.put(src.get(i + position));
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Specified by:
      put in interface Buffer
      Parameters:
      src - The source buffer from which bytes are to be read; must not be this buffer
      position - starting position in the source buffer
      length - number of bytes to be copied
      Returns:
      This buffer

    • wrap

      public static HeapBuffer wrap(byte[] heap)

    • wrap

      public static HeapBuffer wrap(byte[] heap, int off, int len)

    • put

      public HeapBuffer put(byte[] src)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the entire content of the given source byte array into this buffer. An invocation of this method of the form dst.put(a) behaves in exactly the same way as the invocation 

       dst.put(a, 0, a.length)
      Specified by:
      put in interface Buffer
      Parameters:
      src - source of bytes to put into the Buffer
      Returns:
      This buffer

    • put

      public HeapBuffer put(byte[] src, int offset, int length)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers bytes into this buffer from the given source array. If there are more bytes to be copied from the array than remain in this buffer, that is, if length > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies length bytes from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length.

      In other words, an invocation of this method of the form dst.put(src, off, len) has exactly the same effect as the loop 

       for (int i = off; i < off + len; i++)
     dst.put(a[i]);
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Specified by:
      put in interface Buffer
      Parameters:
      src - The array from which bytes are to be read
      offset - The offset within the array of the first byte to be read; must be non-negative and no larger than array.length
      length - The number of bytes to be read from the given array; must be non-negative and no larger than array.length - offset
      Returns:
      This buffer

    • put8BitString

      public HeapBuffer put8BitString(String s)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers bytes into this buffer from the given 8-bit source String. If the source String.length() is bigger than this buffer's remaining, that is, if length() > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies length bytes from the given String into this buffer.

      In other words, an invocation of this method of the form dst.put8BitString(src) has exactly the same effect as the loop 

       for (int i = 0; i < src.length(); i++)
     dst.put((byte) src.charAt(i));
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Specified by:
      put8BitString in interface Buffer
      Parameters:
      s - The String from which bytes are to be read
      Returns:
      This buffer

    • compact

      public HeapBuffer compact()
      Description copied from interface: Buffer
      Compacts this buffer  (optional operation).

      The bytes between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the byte at index p = position() is copied to index zero, the byte at index p + 1 is copied to index one, and so forth until the byte at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.

      The buffer's position is set to the number of bytes copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

      Invoke this method after writing data from a buffer in case the write was incomplete. The following loop, for example, copies bytes from one channel to another via the buffer buf: 

       buf.clear(); // Prepare buffer for use
 for (;;) {
     if (in.read(buf) < 0 && !buf.hasRemaining())
         break; // No more bytes to transfer
     buf.flip();
     out.write(buf);
     buf.compact(); // In case of partial write
 }
      Specified by:
      compact in interface Buffer
      Returns:
      This buffer

    • order

      public ByteOrder order()
      Description copied from interface: Buffer
      Retrieves this buffer's byte order.

      The byte order is used when reading or writing multibyte values, and when creating buffers that are views of this Buffer. The order of a newly-created Buffer is always BIG_ENDIAN.

      Specified by:
      order in interface Buffer
      Returns:
      This buffer's byte order

    • order

      public HeapBuffer order(ByteOrder bo)
      Description copied from interface: Buffer
      Modifies this buffer's byte order.
      Specified by:
      order in interface Buffer
      Parameters:
      bo - The new byte order, either BIG_ENDIAN or LITTLE_ENDIAN
      Returns:
      This buffer

    • getChar

      public char getChar()
      Description copied from interface: Buffer
      Relative get method for reading a char value.

      Reads the next two bytes at this buffer's current position, composing them into a char value according to the current byte order, and then increments the position by two.

      Specified by:
      getChar in interface Buffer
      Returns:
      The char value at the buffer's current position

    • getChar

      public char getChar(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a char value.

      Reads two bytes at the given index, composing them into a char value according to the current byte order.

      Specified by:
      getChar in interface Buffer
      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The char value at the given index

    • putChar

      public HeapBuffer putChar(char value)
      Description copied from interface: Buffer
      Relative put method for writing a char value  (optional operation).

      Writes two bytes containing the given char value, in the current byte order, into this buffer at the current position, and then increments the position by two.

      Specified by:
      putChar in interface Buffer
      Parameters:
      value - The char value to be written
      Returns:
      This buffer

    • putChar

      public HeapBuffer putChar(int index, char value)
      Description copied from interface: Buffer
      Absolute put method for writing a char value  (optional operation).

      Writes two bytes containing the given char value, in the current byte order, into this buffer at the given index.

      Specified by:
      putChar in interface Buffer
      Parameters:
      index - The index at which the bytes will be written
      value - The char value to be written
      Returns:
      This buffer

    • getShort

      public short getShort()
      Description copied from interface: Buffer
      Relative get method for reading a short value.

      Reads the next two bytes at this buffer's current position, composing them into a short value according to the current byte order, and then increments the position by two.

      Specified by:
      getShort in interface Buffer
      Returns:
      The short value at the buffer's current position

    • getShort

      public short getShort(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a short value.

      Reads two bytes at the given index, composing them into a short value according to the current byte order.

      Specified by:
      getShort in interface Buffer
      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The short value at the given index

    • putShort

      public HeapBuffer putShort(short value)
      Description copied from interface: Buffer
      Relative put method for writing a short value  (optional operation).

      Writes two bytes containing the given short value, in the current byte order, into this buffer at the current position, and then increments the position by two.

      Specified by:
      putShort in interface Buffer
      Parameters:
      value - The short value to be written
      Returns:
      This buffer

    • putShort

      public HeapBuffer putShort(int index, short value)
      Description copied from interface: Buffer
      Absolute put method for writing a short value  (optional operation).

      Writes two bytes containing the given short value, in the current byte order, into this buffer at the given index.

      Specified by:
      putShort in interface Buffer
      Parameters:
      index - The index at which the bytes will be written
      value - The short value to be written
      Returns:
      This buffer

    • getInt

      public int getInt()
      Description copied from interface: Buffer
      Relative get method for reading an int value.

      Reads the next four bytes at this buffer's current position, composing them into an int value according to the current byte order, and then increments the position by four.

      Specified by:
      getInt in interface Buffer
      Returns:
      The int value at the buffer's current position

    • getInt

      public int getInt(int index)
      Description copied from interface: Buffer
      Absolute get method for reading an int value.

      Reads four bytes at the given index, composing them into a int value according to the current byte order.

      Specified by:
      getInt in interface Buffer
      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The int value at the given index

    • putInt

      public HeapBuffer putInt(int value)
      Description copied from interface: Buffer
      Relative put method for writing an int value  (optional operation).

      Writes four bytes containing the given int value, in the current byte order, into this buffer at the current position, and then increments the position by four.

      Specified by:
      putInt in interface Buffer
      Parameters:
      value - The int value to be written
      Returns:
      This buffer

    • putInt

      public HeapBuffer putInt(int index, int value)
      Description copied from interface: Buffer
      Absolute put method for writing an int value  (optional operation).

      Writes four bytes containing the given int value, in the current byte order, into this buffer at the given index.

      Specified by:
      putInt in interface Buffer
      Parameters:
      index - The index at which the bytes will be written
      value - The int value to be written
      Returns:
      This buffer

    • getLong

      public long getLong()
      Description copied from interface: Buffer
      Relative get method for reading a long value.

      Reads the next eight bytes at this buffer's current position, composing them into a long value according to the current byte order, and then increments the position by eight.

      Specified by:
      getLong in interface Buffer
      Returns:
      The long value at the buffer's current position

    • getLong

      public long getLong(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a long value.

      Reads eight bytes at the given index, composing them into a long value according to the current byte order.

      Specified by:
      getLong in interface Buffer
      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The long value at the given index

    • putLong

      public HeapBuffer putLong(long value)
      Description copied from interface: Buffer
      Relative put method for writing a long value  (optional operation).

      Writes eight bytes containing the given long value, in the current byte order, into this buffer at the current position, and then increments the position by eight.

      Specified by:
      putLong in interface Buffer
      Parameters:
      value - The long value to be written
      Returns:
      This buffer

    • putLong

      public HeapBuffer putLong(int index, long value)
      Description copied from interface: Buffer
      Absolute put method for writing a long value  (optional operation).

      Writes eight bytes containing the given long value, in the current byte order, into this buffer at the given index.

      Specified by:
      putLong in interface Buffer
      Parameters:
      index - The index at which the bytes will be written
      value - The long value to be written
      Returns:
      This buffer

    • getFloat

      public float getFloat()
      Description copied from interface: Buffer
      Relative get method for reading a float value.

      Reads the next four bytes at this buffer's current position, composing them into a float value according to the current byte order, and then increments the position by four.

      Specified by:
      getFloat in interface Buffer
      Returns:
      The float value at the buffer's current position

    • getFloat

      public float getFloat(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a float value.

      Reads four bytes at the given index, composing them into a float value according to the current byte order.

      Specified by:
      getFloat in interface Buffer
      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The float value at the given index

    • putFloat

      public HeapBuffer putFloat(float value)
      Description copied from interface: Buffer
      Relative put method for writing a float value  (optional operation).

      Writes four bytes containing the given float value, in the current byte order, into this buffer at the current position, and then increments the position by four.

      Specified by:
      putFloat in interface Buffer
      Parameters:
      value - The float value to be written
      Returns:
      This buffer

    • putFloat

      public HeapBuffer putFloat(int index, float value)
      Description copied from interface: Buffer
      Absolute put method for writing a float value  (optional operation).

      Writes four bytes containing the given float value, in the current byte order, into this buffer at the given index.

      Specified by:
      putFloat in interface Buffer
      Parameters:
      index - The index at which the bytes will be written
      value - The float value to be written
      Returns:
      This buffer

    • getDouble

      public double getDouble()
      Description copied from interface: Buffer
      Relative get method for reading a double value.

      Reads the next eight bytes at this buffer's current position, composing them into a double value according to the current byte order, and then increments the position by eight.

      Specified by:
      getDouble in interface Buffer
      Returns:
      The double value at the buffer's current position

    • getDouble

      public double getDouble(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a double value.

      Reads eight bytes at the given index, composing them into a double value according to the current byte order.

      Specified by:
      getDouble in interface Buffer
      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The double value at the given index

    • putDouble

      public HeapBuffer putDouble(double value)
      Description copied from interface: Buffer
      Relative put method for writing a double value  (optional operation).

      Writes eight bytes containing the given double value, in the current byte order, into this buffer at the current position, and then increments the position by eight.

      Specified by:
      putDouble in interface Buffer
      Parameters:
      value - The double value to be written
      Returns:
      This buffer

    • putDouble

      public HeapBuffer putDouble(int index, double value)
      Description copied from interface: Buffer
      Absolute put method for writing a double value  (optional operation).

      Writes eight bytes containing the given double value, in the current byte order, into this buffer at the given index.

      Specified by:
      putDouble in interface Buffer
      Parameters:
      index - The index at which the bytes will be written
      value - The double value to be written
      Returns:
      This buffer

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • compareTo

      public int compareTo(Buffer o)
      Specified by:
      compareTo in interface Comparable<Buffer>

    • checkDispose

      protected void checkDispose()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toStringContent

      public String toStringContent()
      Description copied from interface: Buffer
      Returns Buffer content as String, using default Charset
      Specified by:
      toStringContent in interface Buffer
      Returns:
      String representation of this Buffer content.

    • toStringContent

      public String toStringContent(Charset charset)
      Description copied from interface: Buffer
      Returns Buffer content as String
      Specified by:
      toStringContent in interface Buffer
      Parameters:
      charset - the Charset, which will be use for byte[] -> String transformation.
      Returns:
      String representation of this Buffer content.

    • toStringContent

      public String toStringContent(Charset charset, int position, int limit)
      Description copied from interface: Buffer
      Returns Buffer's chunk content as String
      Specified by:
      toStringContent in interface Buffer
      Parameters:
      charset - the Charset, which will be use for byte[] -> String transformation.
      position - the first byte offset in the Buffer (inclusive)
      limit - the last byte offset in the Buffer (exclusive)
      Returns:
      String representation of part of this Buffer.

    • dumpHex

      public void dumpHex(Appendable appendable)
      Generate a hex dump of this Buffer's content.
      Specified by:
      dumpHex in interface Buffer
      Parameters:
      appendable - the Appendable to dump this Buffer's content to.

    • toByteBuffer

      public ByteBuffer toByteBuffer()

      Converts this Buffer to a ByteBuffer. If this Buffer is not composite - then returned ByteBuffer's content is a shared subsequence of this buffer's content, with CompositeBuffer this is not guaranteed. The position of the returned ByteBuffer is not guaranteed to be 0, the capacity of the returned ByteBuffer is not guaranteed to be equal to the capacity of this Buffer. It is guaranteed that the result of the returned ByteBuffer's Buffer.remaining() call will be equal to this Buffer's Buffer.remaining() call. The Buffer's and ByteBuffer's position, limit, and mark values are not guaranteed to be independent, so it's recommended to save and restore position, limit values if it is planned to change them or ByteBuffer.slice() the returned ByteBuffer.

      Specified by:
      toByteBuffer in interface Buffer
      Returns:
      this Buffer as a ByteBuffer.

    • toByteBuffer

      public ByteBuffer toByteBuffer(int position, int limit)

      Converts this Buffer to a ByteBuffer. If this Buffer is not composite - then returned ByteBuffer's content is a shared subsequence of this buffer's content, with CompositeBuffer this is not guaranteed. The position of the returned ByteBuffer is not guaranteed to be 0, the capacity of the returned ByteBuffer is not guaranteed to be equal to the capacity of this Buffer. It is guaranteed that the result of the returned ByteBuffer's Buffer.remaining() call will be equal (limit - position). The Buffer's and ByteBuffer's position, limit, and mark values are not guaranteed to be independent, so it's recommended to save and restore position, limit values if it is planned to change them or ByteBuffer.slice() the returned ByteBuffer.

      Specified by:
      toByteBuffer in interface Buffer
      Parameters:
      position - the position for the starting subsequence for the returned ByteBuffer.
      limit - the limit for the ending of the subsequence of the returned ByteBuffer.
      Returns:
      this Buffer as a ByteBuffer.

    • toByteBufferArray

      public final ByteBufferArray toByteBufferArray()

      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer() and returns a ByteBufferArray containing the converted ByteBuffer. It is guaranteed that returned array's ByteBuffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Specified by:
      toByteBufferArray in interface Buffer
      Returns:
      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer() and returns a ByteBufferArray containing the converted ByteBuffer.
      See Also:

    • toByteBufferArray

      public final ByteBufferArray toByteBufferArray(int position, int limit)

      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer(int, int) and returns a ByteBufferArray containing the converted ByteBuffer. It is guaranteed that returned array's ByteBuffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Specified by:
      toByteBufferArray in interface Buffer
      Parameters:
      position - the start position within the source buffer
      limit - the limit, or number, of bytes to include in the resulting ByteBuffer
      Returns:
      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer(int, int) and returns a ByteBufferArray containing the converted ByteBuffer.
      See Also:

    • toByteBufferArray

      public final ByteBufferArray toByteBufferArray(ByteBufferArray array)

      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer() and adds the result to the provided ByteBufferArray. It is guaranteed that returned array's ByteBuffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Specified by:
      toByteBufferArray in interface Buffer
      Parameters:
      array - this buffer as a ByteBufferArray
      Returns:
      returns the provided ByteBufferArray with the converted ByteBuffer added to provided array.
      See Also:

    • toByteBufferArray

      public final ByteBufferArray toByteBufferArray(ByteBufferArray array, int position, int limit)

      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer(int, int) and adds the result to the provided ByteBufferArray. It is guaranteed that returned array's ByteBuffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Specified by:
      toByteBufferArray in interface Buffer
      Parameters:
      array - the ByteBufferArray to append this to
      position - the start position within the source buffer
      limit - the limit, or number, of bytes to include in the resulting ByteBuffer
      Returns:
      returns the provided ByteBufferArray with the converted ByteBuffer added to provided array.
      See Also:

    • toBufferArray

      public final BufferArray toBufferArray()

      Returns a new BufferArray instance with this Buffer added as an element to the BufferArray. It is guaranteed that returned array's Buffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Specified by:
      toBufferArray in interface Buffer
      Returns:
      Returns a new BufferArray instance with this Buffer added as an element to the BufferArray.

    • toBufferArray

      public final BufferArray toBufferArray(int position, int limit)

      Updates this Buffer's position and limit and adds it to a new BufferArray instance. It is guaranteed that returned array's Buffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Specified by:
      toBufferArray in interface Buffer
      Parameters:
      position - the new position for this Buffer
      limit - the new limit for this Buffer
      Returns:
      adds this Buffer and returns the specified BufferArray.

    • toBufferArray

      public final BufferArray toBufferArray(BufferArray array)

      Returns the specified BufferArray after adding this Buffer. It is guaranteed that returned array's Buffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Specified by:
      toBufferArray in interface Buffer
      Parameters:
      array - the base array to append to
      Returns:
      Returns the specified BufferArray after adding this Buffer.

    • toBufferArray

      public final BufferArray toBufferArray(BufferArray array, int position, int limit)

      Updates this Buffer's position and limit and adds it to the specified BufferArray. It is guaranteed that returned array's Buffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Specified by:
      toBufferArray in interface Buffer
      Parameters:
      array - the BufferArray to prepend to
      position - the new position for this Buffer
      limit - the new limit for this Buffer
      Returns:
      adds this Buffer and returns the specified BufferArray.

    • release

      public boolean release()
      Description copied from interface: WritableMessage
      Perform message specific actions to release resources held by the entity backing this WritableMessage.
      Specified by:
      release in interface WritableMessage
      Returns:
      true if successfully released

    • isExternal

      public boolean isExternal()
      Returns true if the message represents an external resource (for example FileTransfer), which is not loaded in memory.
      Specified by:
      isExternal in interface WritableMessage
      Returns:
      False, if the message is located in memory (like Buffer).

    • hasArray

      public boolean hasArray()
      Description copied from interface: Buffer
      Tells whether or not this buffer is backed by an accessible byte array. If this method returns true then the array and arrayOffset methods may safely be invoked.
      Specified by:
      hasArray in interface Buffer
      Returns:
      true if, and only if, this buffer is backed by an array and is not read-only

    • arrayOffset

      public int arrayOffset()
      Description copied from interface: Buffer
      Returns the offset within this buffer's backing array of the first element of the buffer (optional operation). If this buffer is backed by an array then buffer position p corresponds to array index p + arrayOffset(). Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.
      Specified by:
      arrayOffset in interface Buffer
      Returns:
      The offset within this buffer's array of the first element of the buffer

    • array

      public byte[] array()
      Description copied from interface: Buffer
      Returns the byte array that backs this buffer (optional operation). Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa. Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.
      Specified by:
      array in interface Buffer
      Returns:
      The array that backs this buffer

    • onShareHeap

      protected void onShareHeap()

    • createHeapBuffer

      protected HeapBuffer createHeapBuffer(int offs, int capacity)
      Create a new HeapBuffer based on the current heap.
      Parameters:
      offs - relative offset, the absolute value will calculated as (this.offset + offs)
      capacity -
      Returns:

    • toByteBuffer0

      protected ByteBuffer toByteBuffer0(int pos, int lim, boolean slice)