Interface ChannelBuffer
-
- All Superinterfaces:
java.lang.Comparable<ChannelBuffer>
- All Known Subinterfaces:
WrappedChannelBuffer
- All Known Implementing Classes:
AbstractChannelBuffer
,BigEndianHeapChannelBuffer
,ByteBufferBackedChannelBuffer
,CompositeChannelBuffer
,DuplicatedChannelBuffer
,DynamicChannelBuffer
,EmptyChannelBuffer
,HeapChannelBuffer
,LittleEndianHeapChannelBuffer
,ReadOnlyChannelBuffer
,ReplayingDecoderBuffer
,SlicedChannelBuffer
,TruncatedChannelBuffer
public interface ChannelBuffer extends java.lang.Comparable<ChannelBuffer>
A random and sequential accessible sequence of zero or more bytes (octets). This interface provides an abstract view for one or more primitive byte arrays (byte[]
) and NIO buffers.Creation of a buffer
It is recommended to create a new buffer using the helper methods inChannelBuffers
rather than calling an individual implementation's constructor.Random Access Indexing
Just like an ordinary primitive byte array,ChannelBuffer
uses zero-based indexing. It means the index of the first byte is always0
and the index of the last byte is alwayscapacity - 1
. For example, to iterate all bytes of a buffer, you can do the following, regardless of its internal implementation:ChannelBuffer
buffer = ...; for (int i = 0; i < buffer.capacity(); i ++) { byte b = buffer.getByte(i); System.out.println((char) b); }Sequential Access Indexing
ChannelBuffer
provides two pointer variables to support sequential read and write operations -readerIndex
for a read operation andwriterIndex
for a write operation respectively. The following diagram shows how a buffer is segmented into three areas by the two pointers:+-------------------+------------------+------------------+ | discardable bytes | readable bytes | writable bytes | | | (CONTENT) | | +-------------------+------------------+------------------+ | | | | 0 <= readerIndex <= writerIndex <= capacity
Readable bytes (the actual content)
This segment is where the actual data is stored. Any operation whose name starts withread
orskip
will get or skip the data at the currentreaderIndex
and increase it by the number of read bytes. If the argument of the read operation is also aChannelBuffer
and no destination index is specified, the specified buffer'sreaderIndex
is increased together.If there's not enough content left,
IndexOutOfBoundsException
is raised. The default value of newly allocated, wrapped or copied buffer'sreaderIndex
is0
.// Iterates the readable bytes of a buffer.
ChannelBuffer
buffer = ...; while (buffer.readable()) { System.out.println(buffer.readByte()); }Writable bytes
This segment is a undefined space which needs to be filled. Any operation whose name ends withwrite
will write the data at the currentwriterIndex
and increase it by the number of written bytes. If the argument of the write operation is also aChannelBuffer
, and no source index is specified, the specified buffer'sreaderIndex
is increased together.If there's not enough writable bytes left,
IndexOutOfBoundsException
is raised. The default value of newly allocated buffer'swriterIndex
is0
. The default value of wrapped or copied buffer'swriterIndex
is thecapacity
of the buffer.// Fills the writable bytes of a buffer with random integers.
ChannelBuffer
buffer = ...; while (buffer.writableBytes() >= 4) { buffer.writeInt(random.nextInt()); }Discardable bytes
This segment contains the bytes which were read already by a read operation. Initially, the size of this segment is0
, but its size increases up to thewriterIndex
as read operations are executed. The read bytes can be discarded by callingdiscardReadBytes()
to reclaim unused area as depicted by the following diagram:BEFORE discardReadBytes() +-------------------+------------------+------------------+ | discardable bytes | readable bytes | writable bytes | +-------------------+------------------+------------------+ | | | | 0 <= readerIndex <= writerIndex <= capacity AFTER discardReadBytes() +------------------+--------------------------------------+ | readable bytes | writable bytes (got more space) | +------------------+--------------------------------------+ | | | readerIndex (0) <= writerIndex (decreased) <= capacity
Please note that there is no guarantee about the content of writable bytes after callingdiscardReadBytes()
. The writable bytes will not be moved in most cases and could even be filled with completely different data depending on the underlying buffer implementation.Clearing the buffer indexes
You can set bothreaderIndex
andwriterIndex
to0
by callingclear()
. It does not clear the buffer content (e.g. filling with0
) but just clears the two pointers. Please also note that the semantic of this operation is different fromBuffer.clear()
.BEFORE clear() +-------------------+------------------+------------------+ | discardable bytes | readable bytes | writable bytes | +-------------------+------------------+------------------+ | | | | 0 <= readerIndex <= writerIndex <= capacity AFTER clear() +---------------------------------------------------------+ | writable bytes (got more space) | +---------------------------------------------------------+ | | 0 = readerIndex = writerIndex <= capacity
Search operations
VariousindexOf(int, int, byte)
methods help you locate an index of a value which meets a certain criteria. Complicated dynamic sequential search can be done withChannelBufferIndexFinder
as well as simple static single byte search.If you are decoding variable length data such as NUL-terminated string, you will find
bytesBefore(byte)
also useful.Mark and reset
There are two marker indexes in every buffer. One is for storingreaderIndex
and the other is for storingwriterIndex
. You can always reposition one of the two indexes by calling a reset method. It works in a similar fashion to the mark and reset methods inInputStream
except that there's noreadlimit
.Derived buffers
You can create a view of an existing buffer by calling eitherduplicate()
,slice()
orslice(int, int)
. A derived buffer will have an independentreaderIndex
,writerIndex
and marker indexes, while it shares other internal data representation, just like a NIO buffer does.In case a completely fresh copy of an existing buffer is required, please call
copy()
method instead.Conversion to existing JDK types
Byte array
If aChannelBuffer
is backed by a byte array (i.e.byte[]
), you can access it directly via thearray()
method. To determine if a buffer is backed by a byte array,hasArray()
should be used.NIO Buffers
VarioustoByteBuffer()
andtoByteBuffers()
methods convert aChannelBuffer
into one or more NIO buffers. These methods avoid buffer allocation and memory copy whenever possible, but there's no guarantee that memory copy will not be involved.Strings
Various#toString(String)
methods convert aChannelBuffer
into aString
. Please note thattoString()
is not a conversion method.I/O Streams
Please refer toChannelBufferInputStream
andChannelBufferOutputStream
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description byte[]
array()
Returns the backing byte array of this buffer.int
arrayOffset()
Returns the offset of the first byte within the backing byte array of this buffer.int
bytesBefore(byte value)
Locates the first occurrence of the specifiedvalue
in this buffer.int
bytesBefore(int length, byte value)
Locates the first occurrence of the specifiedvalue
in this buffer.int
bytesBefore(int index, int length, byte value)
Locates the first occurrence of the specifiedvalue
in this buffer.int
bytesBefore(int index, int length, ChannelBufferIndexFinder indexFinder)
Locates the first place where the specifiedindexFinder
returnstrue
.int
bytesBefore(int length, ChannelBufferIndexFinder indexFinder)
Locates the first place where the specifiedindexFinder
returnstrue
.int
bytesBefore(ChannelBufferIndexFinder indexFinder)
Locates the first place where the specifiedindexFinder
returnstrue
.int
capacity()
Returns the number of bytes (octets) this buffer can contain.void
clear()
Sets thereaderIndex
andwriterIndex
of this buffer to0
.int
compareTo(ChannelBuffer buffer)
Compares the content of the specified buffer to the content of this buffer.ChannelBuffer
copy()
Returns a copy of this buffer's readable bytes.ChannelBuffer
copy(int index, int length)
Returns a copy of this buffer's sub-region.void
discardReadBytes()
Discards the bytes between the 0th index andreaderIndex
.ChannelBuffer
duplicate()
Returns a buffer which shares the whole region of this buffer.void
ensureWritableBytes(int writableBytes)
Makes sure the number of the writable bytes is equal to or greater than the specified value.boolean
equals(java.lang.Object obj)
Determines if the content of the specified buffer is identical to the content of this array.ChannelBufferFactory
factory()
Returns the factory which creates aChannelBuffer
whose type and defaultByteOrder
are same with this buffer.byte
getByte(int index)
Gets a byte at the specified absoluteindex
in this buffer.void
getBytes(int index, byte[] dst)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
.void
getBytes(int index, byte[] dst, int dstIndex, int length)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
.void
getBytes(int index, java.io.OutputStream out, int length)
Transfers this buffer's data to the specified stream starting at the specified absoluteindex
.void
getBytes(int index, java.nio.ByteBuffer dst)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
until the destination's position reaches its limit.int
getBytes(int index, java.nio.channels.GatheringByteChannel out, int length)
Transfers this buffer's data to the specified channel starting at the specified absoluteindex
.void
getBytes(int index, ChannelBuffer dst)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
until the destination becomes non-writable.void
getBytes(int index, ChannelBuffer dst, int length)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
.void
getBytes(int index, ChannelBuffer dst, int dstIndex, int length)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
.char
getChar(int index)
Gets a 2-byte UTF-16 character at the specified absoluteindex
in this buffer.double
getDouble(int index)
Gets a 64-bit floating point number at the specified absoluteindex
in this buffer.float
getFloat(int index)
Gets a 32-bit floating point number at the specified absoluteindex
in this buffer.int
getInt(int index)
Gets a 32-bit integer at the specified absoluteindex
in this buffer.long
getLong(int index)
Gets a 64-bit long integer at the specified absoluteindex
in this buffer.int
getMedium(int index)
Gets a 24-bit medium integer at the specified absoluteindex
in this buffer.short
getShort(int index)
Gets a 16-bit short integer at the specified absoluteindex
in this buffer.short
getUnsignedByte(int index)
Gets an unsigned byte at the specified absoluteindex
in this buffer.long
getUnsignedInt(int index)
Gets an unsigned 32-bit integer at the specified absoluteindex
in this buffer.int
getUnsignedMedium(int index)
Gets an unsigned 24-bit medium integer at the specified absoluteindex
in this buffer.int
getUnsignedShort(int index)
Gets an unsigned 16-bit short integer at the specified absoluteindex
in this buffer.boolean
hasArray()
Returnstrue
if and only if this buffer has a backing byte array.int
hashCode()
Returns a hash code which was calculated from the content of this buffer.int
indexOf(int fromIndex, int toIndex, byte value)
Locates the first occurrence of the specifiedvalue
in this buffer.int
indexOf(int fromIndex, int toIndex, ChannelBufferIndexFinder indexFinder)
Locates the first place where the specifiedindexFinder
returnstrue
.boolean
isDirect()
Returnstrue
if and only if this buffer is backed by an NIO direct buffer.void
markReaderIndex()
Marks the currentreaderIndex
in this buffer.void
markWriterIndex()
Marks the currentwriterIndex
in this buffer.java.nio.ByteOrder
order()
Returns the endianness of this buffer.boolean
readable()
Returnstrue
if and only if(this.writerIndex - this.readerIndex)
is greater than0
.int
readableBytes()
Returns the number of readable bytes which is equal to(this.writerIndex - this.readerIndex)
.byte
readByte()
Gets a byte at the currentreaderIndex
and increases thereaderIndex
by1
in this buffer.void
readBytes(byte[] dst)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=dst.length
).void
readBytes(byte[] dst, int dstIndex, int length)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
).ChannelBuffer
readBytes(int length)
Transfers this buffer's data to a newly created buffer starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
).void
readBytes(java.io.OutputStream out, int length)
Transfers this buffer's data to the specified stream starting at the currentreaderIndex
.void
readBytes(java.nio.ByteBuffer dst)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
until the destination's position reaches its limit, and increases thereaderIndex
by the number of the transferred bytes.int
readBytes(java.nio.channels.GatheringByteChannel out, int length)
Transfers this buffer's data to the specified stream starting at the currentreaderIndex
.void
readBytes(ChannelBuffer dst)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
until the destination becomes non-writable, and increases thereaderIndex
by the number of the transferred bytes.void
readBytes(ChannelBuffer dst, int length)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
).void
readBytes(ChannelBuffer dst, int dstIndex, int length)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
).char
readChar()
Gets a 2-byte UTF-16 character at the currentreaderIndex
and increases thereaderIndex
by2
in this buffer.double
readDouble()
Gets a 64-bit floating point number at the currentreaderIndex
and increases thereaderIndex
by8
in this buffer.int
readerIndex()
Returns thereaderIndex
of this buffer.void
readerIndex(int readerIndex)
Sets thereaderIndex
of this buffer.float
readFloat()
Gets a 32-bit floating point number at the currentreaderIndex
and increases thereaderIndex
by4
in this buffer.int
readInt()
Gets a 32-bit integer at the currentreaderIndex
and increases thereaderIndex
by4
in this buffer.long
readLong()
Gets a 64-bit integer at the currentreaderIndex
and increases thereaderIndex
by8
in this buffer.int
readMedium()
Gets a 24-bit medium integer at the currentreaderIndex
and increases thereaderIndex
by3
in this buffer.short
readShort()
Gets a 16-bit short integer at the currentreaderIndex
and increases thereaderIndex
by2
in this buffer.ChannelBuffer
readSlice(int length)
Returns a new slice of this buffer's sub-region starting at the currentreaderIndex
and increases thereaderIndex
by the size of the new slice (=length
).short
readUnsignedByte()
Gets an unsigned byte at the currentreaderIndex
and increases thereaderIndex
by1
in this buffer.long
readUnsignedInt()
Gets an unsigned 32-bit integer at the currentreaderIndex
and increases thereaderIndex
by4
in this buffer.int
readUnsignedMedium()
Gets an unsigned 24-bit medium integer at the currentreaderIndex
and increases thereaderIndex
by3
in this buffer.int
readUnsignedShort()
Gets an unsigned 16-bit short integer at the currentreaderIndex
and increases thereaderIndex
by2
in this buffer.void
resetReaderIndex()
Repositions the currentreaderIndex
to the markedreaderIndex
in this buffer.void
resetWriterIndex()
Repositions the currentwriterIndex
to the markedwriterIndex
in this buffer.void
setByte(int index, int value)
Sets the specified byte at the specified absoluteindex
in this buffer.void
setBytes(int index, byte[] src)
Transfers the specified source array's data to this buffer starting at the specified absoluteindex
.void
setBytes(int index, byte[] src, int srcIndex, int length)
Transfers the specified source array's data to this buffer starting at the specified absoluteindex
.int
setBytes(int index, java.io.InputStream in, int length)
Transfers the content of the specified source stream to this buffer starting at the specified absoluteindex
.void
setBytes(int index, java.nio.ByteBuffer src)
Transfers the specified source buffer's data to this buffer starting at the specified absoluteindex
until the source buffer's position reaches its limit.int
setBytes(int index, java.nio.channels.ScatteringByteChannel in, int length)
Transfers the content of the specified source channel to this buffer starting at the specified absoluteindex
.void
setBytes(int index, ChannelBuffer src)
Transfers the specified source buffer's data to this buffer starting at the specified absoluteindex
until the source buffer becomes unreadable.void
setBytes(int index, ChannelBuffer src, int length)
Transfers the specified source buffer's data to this buffer starting at the specified absoluteindex
.void
setBytes(int index, ChannelBuffer src, int srcIndex, int length)
Transfers the specified source buffer's data to this buffer starting at the specified absoluteindex
.void
setChar(int index, int value)
Sets the specified 2-byte UTF-16 character at the specified absoluteindex
in this buffer.void
setDouble(int index, double value)
Sets the specified 64-bit floating-point number at the specified absoluteindex
in this buffer.void
setFloat(int index, float value)
Sets the specified 32-bit floating-point number at the specified absoluteindex
in this buffer.void
setIndex(int readerIndex, int writerIndex)
Sets thereaderIndex
andwriterIndex
of this buffer in one shot.void
setInt(int index, int value)
Sets the specified 32-bit integer at the specified absoluteindex
in this buffer.void
setLong(int index, long value)
Sets the specified 64-bit long integer at the specified absoluteindex
in this buffer.void
setMedium(int index, int value)
Sets the specified 24-bit medium integer at the specified absoluteindex
in this buffer.void
setShort(int index, int value)
Sets the specified 16-bit short integer at the specified absoluteindex
in this buffer.void
setZero(int index, int length)
Fills this buffer with NUL (0x00) starting at the specified absoluteindex
.void
skipBytes(int length)
Increases the currentreaderIndex
by the specifiedlength
in this buffer.ChannelBuffer
slice()
Returns a slice of this buffer's readable bytes.ChannelBuffer
slice(int index, int length)
Returns a slice of this buffer's sub-region.java.nio.ByteBuffer
toByteBuffer()
Converts this buffer's readable bytes into a NIO buffer.java.nio.ByteBuffer
toByteBuffer(int index, int length)
Converts this buffer's sub-region into a NIO buffer.java.nio.ByteBuffer[]
toByteBuffers()
Converts this buffer's readable bytes into an array of NIO buffers.java.nio.ByteBuffer[]
toByteBuffers(int index, int length)
Converts this buffer's sub-region into an array of NIO buffers.java.lang.String
toString()
Returns the string representation of this buffer.java.lang.String
toString(int index, int length, java.nio.charset.Charset charset)
Decodes this buffer's sub-region into a string with the specified character set.java.lang.String
toString(java.nio.charset.Charset charset)
Decodes this buffer's readable bytes into a string with the specified character set name.boolean
writable()
Returnstrue
if and only if(this.capacity - this.writerIndex)
is greater than0
.int
writableBytes()
Returns the number of writable bytes which is equal to(this.capacity - this.writerIndex)
.void
writeByte(int value)
Sets the specified byte at the currentwriterIndex
and increases thewriterIndex
by1
in this buffer.void
writeBytes(byte[] src)
Transfers the specified source array's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=src.length
).void
writeBytes(byte[] src, int srcIndex, int length)
Transfers the specified source array's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=length
).int
writeBytes(java.io.InputStream in, int length)
Transfers the content of the specified stream to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes.void
writeBytes(java.nio.ByteBuffer src)
Transfers the specified source buffer's data to this buffer starting at the currentwriterIndex
until the source buffer's position reaches its limit, and increases thewriterIndex
by the number of the transferred bytes.int
writeBytes(java.nio.channels.ScatteringByteChannel in, int length)
Transfers the content of the specified channel to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes.void
writeBytes(ChannelBuffer src)
Transfers the specified source buffer's data to this buffer starting at the currentwriterIndex
until the source buffer becomes unreadable, and increases thewriterIndex
by the number of the transferred bytes.void
writeBytes(ChannelBuffer src, int length)
Transfers the specified source buffer's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=length
).void
writeBytes(ChannelBuffer src, int srcIndex, int length)
Transfers the specified source buffer's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=length
).void
writeChar(int value)
Sets the specified 2-byte UTF-16 character at the currentwriterIndex
and increases thewriterIndex
by2
in this buffer.void
writeDouble(double value)
Sets the specified 64-bit floating point number at the currentwriterIndex
and increases thewriterIndex
by8
in this buffer.void
writeFloat(float value)
Sets the specified 32-bit floating point number at the currentwriterIndex
and increases thewriterIndex
by4
in this buffer.void
writeInt(int value)
Sets the specified 32-bit integer at the currentwriterIndex
and increases thewriterIndex
by4
in this buffer.void
writeLong(long value)
Sets the specified 64-bit long integer at the currentwriterIndex
and increases thewriterIndex
by8
in this buffer.void
writeMedium(int value)
Sets the specified 24-bit medium integer at the currentwriterIndex
and increases thewriterIndex
by3
in this buffer.int
writerIndex()
Returns thewriterIndex
of this buffer.void
writerIndex(int writerIndex)
Sets thewriterIndex
of this buffer.void
writeShort(int value)
Sets the specified 16-bit short integer at the currentwriterIndex
and increases thewriterIndex
by2
in this buffer.void
writeZero(int length)
Fills this buffer with NUL (0x00) starting at the currentwriterIndex
and increases thewriterIndex
by the specifiedlength
.
-
-
-
Method Detail
-
factory
ChannelBufferFactory factory()
Returns the factory which creates aChannelBuffer
whose type and defaultByteOrder
are same with this buffer.
-
capacity
int capacity()
Returns the number of bytes (octets) this buffer can contain.
-
order
java.nio.ByteOrder order()
Returns the endianness of this buffer.
-
isDirect
boolean isDirect()
Returnstrue
if and only if this buffer is backed by an NIO direct buffer.
-
readerIndex
int readerIndex()
Returns thereaderIndex
of this buffer.
-
readerIndex
void readerIndex(int readerIndex)
Sets thereaderIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedreaderIndex
is less than0
or greater thanthis.writerIndex
-
writerIndex
int writerIndex()
Returns thewriterIndex
of this buffer.
-
writerIndex
void writerIndex(int writerIndex)
Sets thewriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedwriterIndex
is less thanthis.readerIndex
or greater thanthis.capacity
-
setIndex
void setIndex(int readerIndex, int writerIndex)
Sets thereaderIndex
andwriterIndex
of this buffer in one shot. This method is useful when you have to worry about the invocation order ofreaderIndex(int)
andwriterIndex(int)
methods. For example, the following code will fail:// Create a buffer whose readerIndex, writerIndex and capacity are // 0, 0 and 8 respectively.
The following code will also fail:ChannelBuffer
buf =ChannelBuffers
.buffer(8); // IndexOutOfBoundsException is thrown because the specified // readerIndex (2) cannot be greater than the current writerIndex (0). buf.readerIndex(2); buf.writerIndex(4);// Create a buffer whose readerIndex, writerIndex and capacity are // 0, 8 and 8 respectively.
By contrast, this method guarantees that it never throws anChannelBuffer
buf =ChannelBuffers
.wrappedBuffer(new byte[8]); // readerIndex becomes 8. buf.readLong(); // IndexOutOfBoundsException is thrown because the specified // writerIndex (4) cannot be less than the current readerIndex (8). buf.writerIndex(4); buf.readerIndex(2);IndexOutOfBoundsException
as long as the specified indexes meet basic constraints, regardless what the current index values of the buffer are:// No matter what the current state of the buffer is, the following // call always succeeds as long as the capacity of the buffer is not // less than 4. buf.setIndex(2, 4);
- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedreaderIndex
is less than 0, if the specifiedwriterIndex
is less than the specifiedreaderIndex
or if the specifiedwriterIndex
is greater thanthis.capacity
-
readableBytes
int readableBytes()
Returns the number of readable bytes which is equal to(this.writerIndex - this.readerIndex)
.
-
writableBytes
int writableBytes()
Returns the number of writable bytes which is equal to(this.capacity - this.writerIndex)
.
-
readable
boolean readable()
Returnstrue
if and only if(this.writerIndex - this.readerIndex)
is greater than0
.
-
writable
boolean writable()
Returnstrue
if and only if(this.capacity - this.writerIndex)
is greater than0
.
-
clear
void clear()
Sets thereaderIndex
andwriterIndex
of this buffer to0
. This method is identical tosetIndex(0, 0)
.Please note that the behavior of this method is different from that of NIO buffer, which sets the
limit
to thecapacity
of the buffer.
-
markReaderIndex
void markReaderIndex()
Marks the currentreaderIndex
in this buffer. You can reposition the currentreaderIndex
to the markedreaderIndex
by callingresetReaderIndex()
. The initial value of the markedreaderIndex
is0
.
-
resetReaderIndex
void resetReaderIndex()
Repositions the currentreaderIndex
to the markedreaderIndex
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the currentwriterIndex
is less than the markedreaderIndex
-
markWriterIndex
void markWriterIndex()
Marks the currentwriterIndex
in this buffer. You can reposition the currentwriterIndex
to the markedwriterIndex
by callingresetWriterIndex()
. The initial value of the markedwriterIndex
is0
.
-
resetWriterIndex
void resetWriterIndex()
Repositions the currentwriterIndex
to the markedwriterIndex
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the currentreaderIndex
is greater than the markedwriterIndex
-
discardReadBytes
void discardReadBytes()
Discards the bytes between the 0th index andreaderIndex
. It moves the bytes betweenreaderIndex
andwriterIndex
to the 0th index, and setsreaderIndex
andwriterIndex
to0
andoldWriterIndex - oldReaderIndex
respectively.Please refer to the class documentation for more detailed explanation.
-
ensureWritableBytes
void ensureWritableBytes(int writableBytes)
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:- a non-dynamic buffer will throw an
IndexOutOfBoundsException
. - a dynamic buffer will expand its capacity so that the number of the
writable bytes
becomes equal to or greater than the specified value. The expansion involves the reallocation of the internal buffer and consequently memory copy.
- Parameters:
writableBytes
- the expected minimum number of writable bytes- Throws:
java.lang.IndexOutOfBoundsException
- if the writable bytes of this buffer is less than the specified value and if this buffer is not a dynamic buffer
- a non-dynamic buffer will throw an
-
getByte
byte getByte(int index)
Gets a byte at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 1
is greater thanthis.capacity
-
getUnsignedByte
short getUnsignedByte(int index)
Gets an unsigned byte at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 1
is greater thanthis.capacity
-
getShort
short getShort(int index)
Gets a 16-bit short integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 2
is greater thanthis.capacity
-
getUnsignedShort
int getUnsignedShort(int index)
Gets an unsigned 16-bit short integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 2
is greater thanthis.capacity
-
getMedium
int getMedium(int index)
Gets a 24-bit medium integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 3
is greater thanthis.capacity
-
getUnsignedMedium
int getUnsignedMedium(int index)
Gets an unsigned 24-bit medium integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 3
is greater thanthis.capacity
-
getInt
int getInt(int index)
Gets a 32-bit integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 4
is greater thanthis.capacity
-
getUnsignedInt
long getUnsignedInt(int index)
Gets an unsigned 32-bit integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 4
is greater thanthis.capacity
-
getLong
long getLong(int index)
Gets a 64-bit long integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 8
is greater thanthis.capacity
-
getChar
char getChar(int index)
Gets a 2-byte UTF-16 character at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 2
is greater thanthis.capacity
-
getFloat
float getFloat(int index)
Gets a 32-bit floating point number at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 4
is greater thanthis.capacity
-
getDouble
double getDouble(int index)
Gets a 64-bit floating point number at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 8
is greater thanthis.capacity
-
getBytes
void getBytes(int index, ChannelBuffer dst)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
until the destination becomes non-writable. This method is basically same withgetBytes(int, ChannelBuffer, int, int)
, except that this method increases thewriterIndex
of the destination by the number of the transferred bytes whilegetBytes(int, ChannelBuffer, int, int)
does not. This method does not modifyreaderIndex
orwriterIndex
of the source buffer (i.e.this
).- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + dst.writableBytes
is greater thanthis.capacity
-
getBytes
void getBytes(int index, ChannelBuffer dst, int length)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
. This method is basically same withgetBytes(int, ChannelBuffer, int, int)
, except that this method increases thewriterIndex
of the destination by the number of the transferred bytes whilegetBytes(int, ChannelBuffer, int, int)
does not. This method does not modifyreaderIndex
orwriterIndex
of the source buffer (i.e.this
).- Parameters:
length
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
, ifindex + length
is greater thanthis.capacity
, or iflength
is greater thandst.writableBytes
-
getBytes
void getBytes(int index, ChannelBuffer dst, int dstIndex, int length)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of both the source (i.e.this
) and the destination.- Parameters:
dstIndex
- the first index of the destinationlength
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
, if the specifieddstIndex
is less than0
, ifindex + length
is greater thanthis.capacity
, or ifdstIndex + length
is greater thandst.capacity
-
getBytes
void getBytes(int index, byte[] dst)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + dst.length
is greater thanthis.capacity
-
getBytes
void getBytes(int index, byte[] dst, int dstIndex, int length)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Parameters:
dstIndex
- the first index of the destinationlength
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
, if the specifieddstIndex
is less than0
, ifindex + length
is greater thanthis.capacity
, or ifdstIndex + length
is greater thandst.length
-
getBytes
void getBytes(int index, java.nio.ByteBuffer dst)
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
until the destination's position reaches its limit. This method does not modifyreaderIndex
orwriterIndex
of this buffer while the destination'sposition
will be increased.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + dst.remaining()
is greater thanthis.capacity
-
getBytes
void getBytes(int index, java.io.OutputStream out, int length) throws java.io.IOException
Transfers this buffer's data to the specified stream starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Parameters:
length
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + length
is greater thanthis.capacity
java.io.IOException
- if the specified stream threw an exception during I/O
-
getBytes
int getBytes(int index, java.nio.channels.GatheringByteChannel out, int length) throws java.io.IOException
Transfers this buffer's data to the specified channel starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Parameters:
length
- the maximum number of bytes to transfer- Returns:
- the actual number of bytes written out to the specified channel
- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + length
is greater thanthis.capacity
java.io.IOException
- if the specified channel threw an exception during I/O
-
setByte
void setByte(int index, int value)
Sets the specified byte at the specified absoluteindex
in this buffer. The 24 high-order bits of the specified value are ignored. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 1
is greater thanthis.capacity
-
setShort
void setShort(int index, int value)
Sets the specified 16-bit short integer at the specified absoluteindex
in this buffer. The 16 high-order bits of the specified value are ignored. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 2
is greater thanthis.capacity
-
setMedium
void setMedium(int index, int value)
Sets the specified 24-bit medium integer at the specified absoluteindex
in this buffer. Please note that the most significant byte is ignored in the specified value. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 3
is greater thanthis.capacity
-
setInt
void setInt(int index, int value)
Sets the specified 32-bit integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 4
is greater thanthis.capacity
-
setLong
void setLong(int index, long value)
Sets the specified 64-bit long integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 8
is greater thanthis.capacity
-
setChar
void setChar(int index, int value)
Sets the specified 2-byte UTF-16 character at the specified absoluteindex
in this buffer. The 16 high-order bits of the specified value are ignored. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 2
is greater thanthis.capacity
-
setFloat
void setFloat(int index, float value)
Sets the specified 32-bit floating-point number at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 4
is greater thanthis.capacity
-
setDouble
void setDouble(int index, double value)
Sets the specified 64-bit floating-point number at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
orindex + 8
is greater thanthis.capacity
-
setBytes
void setBytes(int index, ChannelBuffer src)
Transfers the specified source buffer's data to this buffer starting at the specified absoluteindex
until the source buffer becomes unreadable. This method is basically same withsetBytes(int, ChannelBuffer, int, int)
, except that this method increases thereaderIndex
of the source buffer by the number of the transferred bytes whilesetBytes(int, ChannelBuffer, int, int)
does not. This method does not modifyreaderIndex
orwriterIndex
of the source buffer (i.e.this
).- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + src.readableBytes
is greater thanthis.capacity
-
setBytes
void setBytes(int index, ChannelBuffer src, int length)
Transfers the specified source buffer's data to this buffer starting at the specified absoluteindex
. This method is basically same withsetBytes(int, ChannelBuffer, int, int)
, except that this method increases thereaderIndex
of the source buffer by the number of the transferred bytes whilesetBytes(int, ChannelBuffer, int, int)
does not. This method does not modifyreaderIndex
orwriterIndex
of the source buffer (i.e.this
).- Parameters:
length
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
, ifindex + length
is greater thanthis.capacity
, or iflength
is greater thansrc.readableBytes
-
setBytes
void setBytes(int index, ChannelBuffer src, int srcIndex, int length)
Transfers the specified source buffer's data to this buffer starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of both the source (i.e.this
) and the destination.- Parameters:
srcIndex
- the first index of the sourcelength
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
, if the specifiedsrcIndex
is less than0
, ifindex + length
is greater thanthis.capacity
, or ifsrcIndex + length
is greater thansrc.capacity
-
setBytes
void setBytes(int index, byte[] src)
Transfers the specified source array's data to this buffer starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + src.length
is greater thanthis.capacity
-
setBytes
void setBytes(int index, byte[] src, int srcIndex, int length)
Transfers the specified source array's data to this buffer starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
, if the specifiedsrcIndex
is less than0
, ifindex + length
is greater thanthis.capacity
, or ifsrcIndex + length
is greater thansrc.length
-
setBytes
void setBytes(int index, java.nio.ByteBuffer src)
Transfers the specified source buffer's data to this buffer starting at the specified absoluteindex
until the source buffer's position reaches its limit. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + src.remaining()
is greater thanthis.capacity
-
setBytes
int setBytes(int index, java.io.InputStream in, int length) throws java.io.IOException
Transfers the content of the specified source stream to this buffer starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Parameters:
length
- the number of bytes to transfer- Returns:
- the actual number of bytes read in from the specified channel.
-1
if the specified channel is closed. - Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + length
is greater thanthis.capacity
java.io.IOException
- if the specified stream threw an exception during I/O
-
setBytes
int setBytes(int index, java.nio.channels.ScatteringByteChannel in, int length) throws java.io.IOException
Transfers the content of the specified source channel to this buffer starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Parameters:
length
- the maximum number of bytes to transfer- Returns:
- the actual number of bytes read in from the specified channel.
-1
if the specified channel is closed. - Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + length
is greater thanthis.capacity
java.io.IOException
- if the specified channel threw an exception during I/O
-
setZero
void setZero(int index, int length)
Fills this buffer with NUL (0x00) starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Parameters:
length
- the number of NULs to write to the buffer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedindex
is less than0
or ifindex + length
is greater thanthis.capacity
-
readByte
byte readByte()
Gets a byte at the currentreaderIndex
and increases thereaderIndex
by1
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than1
-
readUnsignedByte
short readUnsignedByte()
Gets an unsigned byte at the currentreaderIndex
and increases thereaderIndex
by1
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than1
-
readShort
short readShort()
Gets a 16-bit short integer at the currentreaderIndex
and increases thereaderIndex
by2
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than2
-
readUnsignedShort
int readUnsignedShort()
Gets an unsigned 16-bit short integer at the currentreaderIndex
and increases thereaderIndex
by2
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than2
-
readMedium
int readMedium()
Gets a 24-bit medium integer at the currentreaderIndex
and increases thereaderIndex
by3
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than3
-
readUnsignedMedium
int readUnsignedMedium()
Gets an unsigned 24-bit medium integer at the currentreaderIndex
and increases thereaderIndex
by3
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than3
-
readInt
int readInt()
Gets a 32-bit integer at the currentreaderIndex
and increases thereaderIndex
by4
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than4
-
readUnsignedInt
long readUnsignedInt()
Gets an unsigned 32-bit integer at the currentreaderIndex
and increases thereaderIndex
by4
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than4
-
readLong
long readLong()
Gets a 64-bit integer at the currentreaderIndex
and increases thereaderIndex
by8
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than8
-
readChar
char readChar()
Gets a 2-byte UTF-16 character at the currentreaderIndex
and increases thereaderIndex
by2
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than2
-
readFloat
float readFloat()
Gets a 32-bit floating point number at the currentreaderIndex
and increases thereaderIndex
by4
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than4
-
readDouble
double readDouble()
Gets a 64-bit floating point number at the currentreaderIndex
and increases thereaderIndex
by8
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.readableBytes
is less than8
-
readBytes
ChannelBuffer readBytes(int length)
Transfers this buffer's data to a newly created buffer starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
). The returned buffer'sreaderIndex
andwriterIndex
are0
andlength
respectively.- Parameters:
length
- the number of bytes to transfer- Returns:
- the newly created buffer which contains the transferred bytes
- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.readableBytes
-
readSlice
ChannelBuffer readSlice(int length)
Returns a new slice of this buffer's sub-region starting at the currentreaderIndex
and increases thereaderIndex
by the size of the new slice (=length
).- Parameters:
length
- the size of the new slice- Returns:
- the newly created slice
- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.readableBytes
-
readBytes
void readBytes(ChannelBuffer dst)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
until the destination becomes non-writable, and increases thereaderIndex
by the number of the transferred bytes. This method is basically same withreadBytes(ChannelBuffer, int, int)
, except that this method increases thewriterIndex
of the destination by the number of the transferred bytes whilereadBytes(ChannelBuffer, int, int)
does not.- Throws:
java.lang.IndexOutOfBoundsException
- ifdst.writableBytes
is greater thanthis.readableBytes
-
readBytes
void readBytes(ChannelBuffer dst, int length)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
). This method is basically same withreadBytes(ChannelBuffer, int, int)
, except that this method increases thewriterIndex
of the destination by the number of the transferred bytes (=length
) whilereadBytes(ChannelBuffer, int, int)
does not.- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.readableBytes
or iflength
is greater thandst.writableBytes
-
readBytes
void readBytes(ChannelBuffer dst, int dstIndex, int length)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
).- Parameters:
dstIndex
- the first index of the destinationlength
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifieddstIndex
is less than0
, iflength
is greater thanthis.readableBytes
, or ifdstIndex + length
is greater thandst.capacity
-
readBytes
void readBytes(byte[] dst)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=dst.length
).- Throws:
java.lang.IndexOutOfBoundsException
- ifdst.length
is greater thanthis.readableBytes
-
readBytes
void readBytes(byte[] dst, int dstIndex, int length)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
).- Parameters:
dstIndex
- the first index of the destinationlength
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifieddstIndex
is less than0
, iflength
is greater thanthis.readableBytes
, or ifdstIndex + length
is greater thandst.length
-
readBytes
void readBytes(java.nio.ByteBuffer dst)
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
until the destination's position reaches its limit, and increases thereaderIndex
by the number of the transferred bytes.- Throws:
java.lang.IndexOutOfBoundsException
- ifdst.remaining()
is greater thanthis.readableBytes
-
readBytes
void readBytes(java.io.OutputStream out, int length) throws java.io.IOException
Transfers this buffer's data to the specified stream starting at the currentreaderIndex
.- Parameters:
length
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.readableBytes
java.io.IOException
- if the specified stream threw an exception during I/O
-
readBytes
int readBytes(java.nio.channels.GatheringByteChannel out, int length) throws java.io.IOException
Transfers this buffer's data to the specified stream starting at the currentreaderIndex
.- Parameters:
length
- the maximum number of bytes to transfer- Returns:
- the actual number of bytes written out to the specified channel
- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.readableBytes
java.io.IOException
- if the specified channel threw an exception during I/O
-
skipBytes
void skipBytes(int length)
Increases the currentreaderIndex
by the specifiedlength
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.readableBytes
-
writeByte
void writeByte(int value)
Sets the specified byte at the currentwriterIndex
and increases thewriterIndex
by1
in this buffer. The 24 high-order bits of the specified value are ignored.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.writableBytes
is less than1
-
writeShort
void writeShort(int value)
Sets the specified 16-bit short integer at the currentwriterIndex
and increases thewriterIndex
by2
in this buffer. The 16 high-order bits of the specified value are ignored.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.writableBytes
is less than2
-
writeMedium
void writeMedium(int value)
Sets the specified 24-bit medium integer at the currentwriterIndex
and increases thewriterIndex
by3
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.writableBytes
is less than3
-
writeInt
void writeInt(int value)
Sets the specified 32-bit integer at the currentwriterIndex
and increases thewriterIndex
by4
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.writableBytes
is less than4
-
writeLong
void writeLong(long value)
Sets the specified 64-bit long integer at the currentwriterIndex
and increases thewriterIndex
by8
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.writableBytes
is less than8
-
writeChar
void writeChar(int value)
Sets the specified 2-byte UTF-16 character at the currentwriterIndex
and increases thewriterIndex
by2
in this buffer. The 16 high-order bits of the specified value are ignored.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.writableBytes
is less than2
-
writeFloat
void writeFloat(float value)
Sets the specified 32-bit floating point number at the currentwriterIndex
and increases thewriterIndex
by4
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.writableBytes
is less than4
-
writeDouble
void writeDouble(double value)
Sets the specified 64-bit floating point number at the currentwriterIndex
and increases thewriterIndex
by8
in this buffer.- Throws:
java.lang.IndexOutOfBoundsException
- ifthis.writableBytes
is less than8
-
writeBytes
void writeBytes(ChannelBuffer src)
Transfers the specified source buffer's data to this buffer starting at the currentwriterIndex
until the source buffer becomes unreadable, and increases thewriterIndex
by the number of the transferred bytes. This method is basically same withwriteBytes(ChannelBuffer, int, int)
, except that this method increases thereaderIndex
of the source buffer by the number of the transferred bytes whilewriteBytes(ChannelBuffer, int, int)
does not.- Throws:
java.lang.IndexOutOfBoundsException
- ifsrc.readableBytes
is greater thanthis.writableBytes
-
writeBytes
void writeBytes(ChannelBuffer src, int length)
Transfers the specified source buffer's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=length
). This method is basically same withwriteBytes(ChannelBuffer, int, int)
, except that this method increases thereaderIndex
of the source buffer by the number of the transferred bytes (=length
) whilewriteBytes(ChannelBuffer, int, int)
does not.- Parameters:
length
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.writableBytes
or iflength
is greater thensrc.readableBytes
-
writeBytes
void writeBytes(ChannelBuffer src, int srcIndex, int length)
Transfers the specified source buffer's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=length
).- Parameters:
srcIndex
- the first index of the sourcelength
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedsrcIndex
is less than0
, ifsrcIndex + length
is greater thansrc.capacity
, or iflength
is greater thanthis.writableBytes
-
writeBytes
void writeBytes(byte[] src)
Transfers the specified source array's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=src.length
).- Throws:
java.lang.IndexOutOfBoundsException
- ifsrc.length
is greater thanthis.writableBytes
-
writeBytes
void writeBytes(byte[] src, int srcIndex, int length)
Transfers the specified source array's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=length
).- Parameters:
srcIndex
- the first index of the sourcelength
- the number of bytes to transfer- Throws:
java.lang.IndexOutOfBoundsException
- if the specifiedsrcIndex
is less than0
, ifsrcIndex + length
is greater thansrc.length
, or iflength
is greater thanthis.writableBytes
-
writeBytes
void writeBytes(java.nio.ByteBuffer src)
Transfers the specified source buffer's data to this buffer starting at the currentwriterIndex
until the source buffer's position reaches its limit, and increases thewriterIndex
by the number of the transferred bytes.- Throws:
java.lang.IndexOutOfBoundsException
- ifsrc.remaining()
is greater thanthis.writableBytes
-
writeBytes
int writeBytes(java.io.InputStream in, int length) throws java.io.IOException
Transfers the content of the specified stream to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes.- Parameters:
length
- the number of bytes to transfer- Returns:
- the actual number of bytes read in from the specified stream
- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.writableBytes
java.io.IOException
- if the specified stream threw an exception during I/O
-
writeBytes
int writeBytes(java.nio.channels.ScatteringByteChannel in, int length) throws java.io.IOException
Transfers the content of the specified channel to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes.- Parameters:
length
- the maximum number of bytes to transfer- Returns:
- the actual number of bytes read in from the specified channel
- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.writableBytes
java.io.IOException
- if the specified channel threw an exception during I/O
-
writeZero
void writeZero(int length)
Fills this buffer with NUL (0x00) starting at the currentwriterIndex
and increases thewriterIndex
by the specifiedlength
.- Parameters:
length
- the number of NULs to write to the buffer- Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.writableBytes
-
indexOf
int indexOf(int fromIndex, int toIndex, byte value)
Locates the first occurrence of the specifiedvalue
in this buffer. The search takes place from the specifiedfromIndex
(inclusive) to the specifiedtoIndex
(exclusive).If
fromIndex
is greater thantoIndex
, the search is performed in a reversed order.This method does not modify
readerIndex
orwriterIndex
of this buffer.- Returns:
- the absolute index of the first occurrence if found.
-1
otherwise.
-
indexOf
int indexOf(int fromIndex, int toIndex, ChannelBufferIndexFinder indexFinder)
Locates the first place where the specifiedindexFinder
returnstrue
. The search takes place from the specifiedfromIndex
(inclusive) to the specifiedtoIndex
(exclusive).If
fromIndex
is greater thantoIndex
, the search is performed in a reversed order.This method does not modify
readerIndex
orwriterIndex
of this buffer.- Returns:
- the absolute index where the specified
indexFinder
returnedtrue
.-1
if theindexFinder
did not returntrue
at all.
-
bytesBefore
int bytesBefore(byte value)
Locates the first occurrence of the specifiedvalue
in this buffer. The search takes place from the currentreaderIndex
(inclusive) to the currentwriterIndex
(exclusive).This method does not modify
readerIndex
orwriterIndex
of this buffer.- Returns:
- the number of bytes between the current
readerIndex
and the first occurrence if found.-1
otherwise.
-
bytesBefore
int bytesBefore(ChannelBufferIndexFinder indexFinder)
Locates the first place where the specifiedindexFinder
returnstrue
. The search takes place from the currentreaderIndex
(inclusive) to the currentwriterIndex
.This method does not modify
readerIndex
orwriterIndex
of this buffer.- Returns:
- the number of bytes between the current
readerIndex
and the first place where theindexFinder
returnedtrue
.-1
if theindexFinder
did not returntrue
at all.
-
bytesBefore
int bytesBefore(int length, byte value)
Locates the first occurrence of the specifiedvalue
in this buffer. The search starts from the currentreaderIndex
(inclusive) and lasts for the specifiedlength
.This method does not modify
readerIndex
orwriterIndex
of this buffer.- Returns:
- the number of bytes between the current
readerIndex
and the first occurrence if found.-1
otherwise. - Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.readableBytes
-
bytesBefore
int bytesBefore(int length, ChannelBufferIndexFinder indexFinder)
Locates the first place where the specifiedindexFinder
returnstrue
. The search starts the currentreaderIndex
(inclusive) and lasts for the specifiedlength
.This method does not modify
readerIndex
orwriterIndex
of this buffer.- Returns:
- the number of bytes between the current
readerIndex
and the first place where theindexFinder
returnedtrue
.-1
if theindexFinder
did not returntrue
at all. - Throws:
java.lang.IndexOutOfBoundsException
- iflength
is greater thanthis.readableBytes
-
bytesBefore
int bytesBefore(int index, int length, byte value)
Locates the first occurrence of the specifiedvalue
in this buffer. The search starts from the specifiedindex
(inclusive) and lasts for the specifiedlength
.This method does not modify
readerIndex
orwriterIndex
of this buffer.- Returns:
- the number of bytes between the specified
index
and the first occurrence if found.-1
otherwise. - Throws:
java.lang.IndexOutOfBoundsException
- ifindex + length
is greater thanthis.capacity
-
bytesBefore
int bytesBefore(int index, int length, ChannelBufferIndexFinder indexFinder)
Locates the first place where the specifiedindexFinder
returnstrue
. The search starts the specifiedindex
(inclusive) and lasts for the specifiedlength
.This method does not modify
readerIndex
orwriterIndex
of this buffer.- Returns:
- the number of bytes between the specified
index
and the first place where theindexFinder
returnedtrue
.-1
if theindexFinder
did not returntrue
at all. - Throws:
java.lang.IndexOutOfBoundsException
- ifindex + length
is greater thanthis.capacity
-
copy
ChannelBuffer 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 tobuf.copy(buf.readerIndex(), buf.readableBytes())
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
copy
ChannelBuffer copy(int index, int 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 modifyreaderIndex
orwriterIndex
of this buffer.
-
slice
ChannelBuffer 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 tobuf.slice(buf.readerIndex(), buf.readableBytes())
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
slice
ChannelBuffer slice(int index, int 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 modifyreaderIndex
orwriterIndex
of this buffer.
-
duplicate
ChannelBuffer duplicate()
Returns a buffer which shares the whole region of this buffer. 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 tobuf.slice(0, buf.capacity())
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
toByteBuffer
java.nio.ByteBuffer toByteBuffer()
Converts this buffer's readable bytes into a NIO buffer. The returned buffer might or might not share the content with this buffer, while they have separate indexes and marks. This method is identical tobuf.toByteBuffer(buf.readerIndex(), buf.readableBytes())
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
toByteBuffer
java.nio.ByteBuffer toByteBuffer(int index, int length)
Converts this buffer's sub-region into a NIO buffer. The returned buffer might or might not share the content with this buffer, while they have separate indexes and marks. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
toByteBuffers
java.nio.ByteBuffer[] toByteBuffers()
Converts this buffer's readable bytes into an array of NIO buffers. The returned buffers might or might not share the content with this buffer, while they have separate indexes and marks. This method is identical tobuf.toByteBuffers(buf.readerIndex(), buf.readableBytes())
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
toByteBuffers
java.nio.ByteBuffer[] toByteBuffers(int index, int length)
Converts this buffer's sub-region into an array of NIO buffers. The returned buffers might or might not share the content with this buffer, while they have separate indexes and marks. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
hasArray
boolean hasArray()
Returnstrue
if and only if this buffer has a backing byte array. If this method returns true, you can safely callarray()
andarrayOffset()
.
-
array
byte[] array()
Returns the backing byte array of this buffer.- Throws:
java.lang.UnsupportedOperationException
- if there no accessible backing byte array
-
arrayOffset
int arrayOffset()
Returns the offset of the first byte within the backing byte array of this buffer.- Throws:
java.lang.UnsupportedOperationException
- if there no accessible backing byte array
-
toString
java.lang.String toString(java.nio.charset.Charset charset)
Decodes this buffer's readable bytes into a string with the specified character set name. This method is identical tobuf.toString(buf.readerIndex(), buf.readableBytes(), charsetName)
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.- Throws:
java.nio.charset.UnsupportedCharsetException
- if the specified character set name is not supported by the current VM
-
toString
java.lang.String toString(int index, int length, java.nio.charset.Charset charset)
Decodes this buffer's sub-region into a string with the specified character set. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
hashCode
int hashCode()
Returns a hash code which was calculated from the content of this buffer. If there's a byte array which is equal to this array, both arrays should return the same value.- Overrides:
hashCode
in classjava.lang.Object
-
equals
boolean equals(java.lang.Object obj)
Determines if the content of the specified buffer is identical to the content of this array. 'Identical' here means:- the size of the contents of the two buffers are same and
- every single byte of the content of the two buffers are same.
readerIndex()
norwriterIndex()
. This method also returnsfalse
fornull
and an object which is not an instance ofChannelBuffer
type.- Overrides:
equals
in classjava.lang.Object
-
compareTo
int compareTo(ChannelBuffer buffer)
Compares the content of the specified buffer to the content of this buffer. Comparison is performed in the same manner with the string comparison functions of various languages such asstrcmp
,memcmp
andString.compareTo(String)
.- Specified by:
compareTo
in interfacejava.lang.Comparable<ChannelBuffer>
-
toString
java.lang.String toString()
Returns the string representation of this buffer. This method does not necessarily return the whole content of the buffer but returns the values of the key properties such asreaderIndex()
,writerIndex()
andcapacity()
.- Overrides:
toString
in classjava.lang.Object
-
-