Class ByteBufNIO
- All Implemented Interfaces:
ByteBuf
ByteBuf
which simply wraps an NIO ByteBuffer
and forwards all calls to it.- Since:
- 3.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbyte[]
array()
Returns the byte array that backs this buffer (optional operation).asNIO()
Gets the underlying NIOByteBuffer
.Creates a new, read-only byte buffer that shares this buffer's content.int
capacity()
Returns this buffer's capacity.clear()
Clears this buffer.Creates a new byte buffer that shares this buffer's content.flip()
Flips this buffer.byte
get()
Relative get method.get
(byte[] bytes) Relative bulkget
method.get
(byte[] bytes, int offset, int length) Relative bulk get method.byte
get
(int index) Absolute get method.get
(int index, byte[] bytes) Absolute bulkget
method.get
(int index, byte[] bytes, int offset, int length) Absolute bulk get method.double
Relative get method for reading a double value.double
getDouble
(int index) Absolute get method for reading a double value.int
getInt()
Relative get method for reading an int value.int
getInt
(int index) Absolute get method for reading an int value.long
getLong()
Relative get method for reading a long value.long
getLong
(int index) Absolute get method for reading a long value.int
Gets the current reference count, which is 1 for a newByteBuf
.boolean
States whether there are any elements between the current position and the limit.int
limit()
Returns this buffer's limit.limit
(int newLimit) Sets this buffer's limit.Modifies this buffer's byte order.int
position()
Returns this buffer's position.position
(int newPosition) Sets this buffer's position.put
(byte b) Relative put method (optional operation).put
(byte[] src, int offset, int length) Relative bulk put method (optional operation).put
(int index, byte b) Absolute put method (optional operation).void
release()
Release a reference to this object.int
Returns the number of elements between the current position and the limit.retain()
Retain an additional reference to this object.
-
Constructor Details
-
ByteBufNIO
Creates a new instance.- Parameters:
buf
- theByteBuffer
to wrap.
-
-
Method Details
-
getReferenceCount
public int getReferenceCount()Description copied from interface:ByteBuf
Gets the current reference count, which is 1 for a newByteBuf
.- Specified by:
getReferenceCount
in interfaceByteBuf
- Returns:
- the current count, which must be greater than or equal to 0
-
retain
Description copied from interface:ByteBuf
Retain an additional reference to this object. All retained references must be released, or there will be a leak. -
release
public void release()Description copied from interface:ByteBuf
Release a reference to this object. -
capacity
public int capacity()Description copied from interface:ByteBuf
Returns this buffer's capacity. -
put
Description copied from interface:ByteBuf
Absolute put method (optional operation).
Writes the given byte into this buffer at the given index.
-
remaining
public int remaining()Description copied from interface:ByteBuf
Returns the number of elements between the current position and the limit. -
put
Description copied from interface:ByteBuf
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 aBufferOverflowException
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 bylength
.In other words, an invocation of this method of the form
dst.put(src, off, len)
has exactly the same effect as the loopfor (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 interfaceByteBuf
- Parameters:
src
- The array from which bytes are to be readoffset
- The offset within the array of the first byte to be read; must be non-negative and no larger thanarray.length
length
- The number of bytes to be read from the given array; must be non-negative and no larger thanarray.length - offset
- Returns:
- This buffer
-
hasRemaining
public boolean hasRemaining()Description copied from interface:ByteBuf
States whether there are any elements between the current position and the limit.- Specified by:
hasRemaining
in interfaceByteBuf
- Returns:
true
if, and only if, there is at least one element remaining in this buffer
-
put
Description copied from interface:ByteBuf
Relative put method (optional operation).
Writes the given byte into this buffer at the current position, and then increments the position.
-
flip
Description copied from interface:ByteBuf
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. -
array
public byte[] array()Description copied from interface:ByteBuf
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.
-
limit
public int limit()Description copied from interface:ByteBuf
Returns this buffer's limit. -
position
Description copied from interface:ByteBuf
Sets this buffer's position. If the mark is defined and larger than the new position then it is discarded. -
clear
Description copied from interface:ByteBuf
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.
-
order
Description copied from interface:ByteBuf
Modifies this buffer's byte order.- Specified by:
order
in interfaceByteBuf
- Parameters:
byteOrder
- The new byte order, eitherBIG_ENDIAN
orLITTLE_ENDIAN
- Returns:
- This buffer
-
get
public byte get()Description copied from interface:ByteBuf
Relative get method. Reads the byte at this buffer's current position, and then increments the position. -
get
public byte get(int index) Description copied from interface:ByteBuf
Absolute get method. Reads the byte at the given index. -
get
Description copied from interface:ByteBuf
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)
-
get
Description copied from interface:ByteBuf
Absolute 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(index, a, 0, a.length)
-
get
Description copied from interface:ByteBuf
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 aBufferUnderflowException
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 bylength
.In other words, an invocation of this method of the form
src.get(dst, off, len)
has exactly the same effect as the loopfor (int i = off; i < off + len; i++) dst[i] = src.get();
- Specified by:
get
in interfaceByteBuf
- Parameters:
bytes
- The array into which bytes are to be writtenoffset
- The offset within the array of the first byte to be written; must be non-negative and no larger thandst.length
length
- The maximum number of bytes to be written to the given array; must be non-negative and no larger thandst.length - offset
- Returns:
- This buffer
-
get
Description copied from interface:ByteBuf
Absolute 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 aBufferUnderflowException
is thrown.Otherwise, this method copies
length
bytes from this buffer into the given array, starting at the given index buffer and at the given offset in the array.In other words, an invocation of this method of the form
src.get(dst, off, len)
has exactly the same effect as the loopfor (int i = off; i < off + len; i++) dst[i] = src.get(i);
- Specified by:
get
in interfaceByteBuf
- Parameters:
index
- The index from which the bytes will be readbytes
- The array into which bytes are to be writtenoffset
- The offset within the array of the first byte to be written; must be non-negative and no larger thandst.length
length
- The maximum number of bytes to be written to the given array; must be non-negative and no larger thandst.length - offset
- Returns:
- This buffer
-
getLong
public long getLong()Description copied from interface:ByteBuf
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.
-
getLong
public long getLong(int index) Description copied from interface:ByteBuf
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.
-
getDouble
public double getDouble()Description copied from interface:ByteBuf
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.
-
getDouble
public double getDouble(int index) Description copied from interface:ByteBuf
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.
-
getInt
public int getInt()Description copied from interface:ByteBuf
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.
-
getInt
public int getInt(int index) Description copied from interface:ByteBuf
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.
-
position
public int position()Description copied from interface:ByteBuf
Returns this buffer's position. -
limit
Description copied from interface:ByteBuf
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. -
asReadOnly
Description copied from interface:ByteBuf
Creates a new, read-only byte 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 buffers' 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.
- Specified by:
asReadOnly
in interfaceByteBuf
- Returns:
- The new, read-only byte buffer
-
duplicate
Description copied from interface:ByteBuf
Creates a new byte 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 buffers' 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.
-
asNIO
Description copied from interface:ByteBuf
Gets the underlying NIOByteBuffer
. Changes made directly to the returned buffer will be reflected in this instance, and vice versa, so be careful. This method should really only be used so that the underlying buffer can be passed directly to a socket channel.
-