public class CompositeChannelBuffer extends AbstractChannelBuffer
ChannelBuffers.wrappedBuffer(ChannelBuffer...)
instead of calling the constructor explicitly.Constructor and Description |
---|
CompositeChannelBuffer(ByteOrder endianness,
List<ChannelBuffer> buffers,
boolean gathering) |
Modifier and Type | Method and 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 |
capacity()
Returns the number of bytes (octets) this buffer can contain.
|
ChannelBuffer |
copy(int index,
int length)
Returns a copy of this buffer's sub-region.
|
List<ChannelBuffer> |
decompose(int index,
int length)
Same with
slice(int, int) except that this method returns a list. |
void |
discardReadBytes()
Discards the bytes between the 0th index and
readerIndex . |
ChannelBuffer |
duplicate()
Returns a buffer which shares the whole region of this buffer.
|
ChannelBufferFactory |
factory()
Returns the factory which creates a
ChannelBuffer whose
type and default ByteOrder are same with this buffer. |
ChannelBuffer |
getBuffer(int index)
|
byte |
getByte(int index)
Gets a byte at the specified absolute
index in this buffer. |
void |
getBytes(int index,
byte[] dst,
int dstIndex,
int length)
Transfers this buffer's data to the specified destination starting at
the specified absolute
index . |
void |
getBytes(int index,
ByteBuffer dst)
Transfers this buffer's data to the specified destination starting at
the specified absolute
index until the destination's position
reaches its limit. |
void |
getBytes(int index,
ChannelBuffer dst,
int dstIndex,
int length)
Transfers this buffer's data to the specified destination starting at
the specified absolute
index . |
int |
getBytes(int index,
GatheringByteChannel out,
int length)
Transfers this buffer's data to the specified channel starting at the
specified absolute
index . |
void |
getBytes(int index,
OutputStream out,
int length)
Transfers this buffer's data to the specified stream starting at the
specified absolute
index . |
int |
getInt(int index)
Gets a 32-bit integer at the specified absolute
index in
this buffer. |
long |
getLong(int index)
Gets a 64-bit long integer at the specified absolute
index in
this buffer. |
short |
getShort(int index)
Gets a 16-bit short integer at the specified absolute
index in
this buffer. |
int |
getUnsignedMedium(int index)
Gets an unsigned 24-bit medium integer at the specified absolute
index in this buffer. |
boolean |
hasArray()
Returns
true if and only if this buffer has a backing byte array. |
boolean |
isDirect()
Returns
true if and only if this buffer is backed by an
NIO direct buffer. |
int |
numComponents() |
ByteOrder |
order()
Returns the endianness
of this buffer.
|
void |
setByte(int index,
int value)
Sets the specified byte at the specified absolute
index in this
buffer. |
void |
setBytes(int index,
byte[] src,
int srcIndex,
int length)
Transfers the specified source array's data to this buffer starting at
the specified absolute
index . |
void |
setBytes(int index,
ByteBuffer src)
Transfers the specified source buffer's data to this buffer starting at
the specified absolute
index until the source buffer's position
reaches its limit. |
void |
setBytes(int index,
ChannelBuffer src,
int srcIndex,
int length)
Transfers the specified source buffer's data to this buffer starting at
the specified absolute
index . |
int |
setBytes(int index,
InputStream in,
int length)
Transfers the content of the specified source stream to this buffer
starting at the specified absolute
index . |
int |
setBytes(int index,
ScatteringByteChannel in,
int length)
Transfers the content of the specified source channel to this buffer
starting at the specified absolute
index . |
void |
setInt(int index,
int value)
Sets the specified 32-bit integer at the specified absolute
index in this buffer. |
void |
setLong(int index,
long value)
Sets the specified 64-bit long integer at the specified absolute
index in this buffer. |
void |
setMedium(int index,
int value)
Sets the specified 24-bit medium integer at the specified absolute
index in this buffer. |
void |
setShort(int index,
int value)
Sets the specified 16-bit short integer at the specified absolute
index in this buffer. |
ChannelBuffer |
slice(int index,
int length)
Returns a slice of this buffer's sub-region.
|
ByteBuffer |
toByteBuffer(int index,
int length)
Converts this buffer's sub-region into a NIO buffer.
|
ByteBuffer[] |
toByteBuffers(int index,
int length)
Converts this buffer's sub-region into an array of NIO buffers.
|
String |
toString()
Returns the string representation of this buffer.
|
boolean |
useGathering()
Return
true if gathering writes / reads should be used
for this CompositeChannelBuffer |
bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, checkReadableBytes, clear, compareTo, copy, ensureWritableBytes, equals, getBytes, getBytes, getBytes, getChar, getDouble, getFloat, getMedium, getUnsignedByte, getUnsignedInt, getUnsignedShort, hashCode, indexOf, indexOf, markReaderIndex, markWriterIndex, readable, readableBytes, readByte, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readChar, readDouble, readerIndex, readerIndex, readFloat, readInt, readLong, readMedium, readShort, readSlice, readSlice, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, resetReaderIndex, resetWriterIndex, setBytes, setBytes, setBytes, setChar, setDouble, setFloat, setIndex, setZero, skipBytes, skipBytes, slice, toByteBuffer, toByteBuffers, toString, toString, toString, toString, toString, toString, writable, writableBytes, writeByte, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writerIndex, writerIndex, writeShort, writeZero
public CompositeChannelBuffer(ByteOrder endianness, List<ChannelBuffer> buffers, boolean gathering)
public boolean useGathering()
true
if gathering writes / reads should be used
for this CompositeChannelBuffer
public List<ChannelBuffer> decompose(int index, int length)
slice(int, int)
except that this method returns a list.public ChannelBufferFactory factory()
ChannelBuffer
ChannelBuffer
whose
type and default ByteOrder
are same with this buffer.public ByteOrder order()
ChannelBuffer
public boolean isDirect()
ChannelBuffer
true
if and only if this buffer is backed by an
NIO direct buffer.public boolean hasArray()
ChannelBuffer
true
if and only if this buffer has a backing byte array.
If this method returns true, you can safely call ChannelBuffer.array()
and
ChannelBuffer.arrayOffset()
.public byte[] array()
ChannelBuffer
public int arrayOffset()
ChannelBuffer
public int capacity()
ChannelBuffer
public int numComponents()
public byte getByte(int index)
ChannelBuffer
index
in this buffer.
This method does not modify readerIndex
or writerIndex
of
this buffer.public short getShort(int index)
ChannelBuffer
index
in
this buffer. This method does not modify readerIndex
or
writerIndex
of this buffer.public int getUnsignedMedium(int index)
ChannelBuffer
index
in this buffer. This method does not modify
readerIndex
or writerIndex
of this buffer.public int getInt(int index)
ChannelBuffer
index
in
this buffer. This method does not modify readerIndex
or
writerIndex
of this buffer.public long getLong(int index)
ChannelBuffer
index
in
this buffer. This method does not modify readerIndex
or
writerIndex
of this buffer.public void getBytes(int index, byte[] dst, int dstIndex, int length)
ChannelBuffer
index
.
This method does not modify readerIndex
or writerIndex
of this buffer.dstIndex
- the first index of the destinationlength
- the number of bytes to transferpublic void getBytes(int index, ByteBuffer dst)
ChannelBuffer
index
until the destination's position
reaches its limit.
This method does not modify readerIndex
or writerIndex
of
this buffer while the destination's position
will be increased.public void getBytes(int index, ChannelBuffer dst, int dstIndex, int length)
ChannelBuffer
index
.
This method does not modify readerIndex
or writerIndex
of both the source (i.e. this
) and the destination.dstIndex
- the first index of the destinationlength
- the number of bytes to transferpublic int getBytes(int index, GatheringByteChannel out, int length) throws IOException
ChannelBuffer
index
.
This method does not modify readerIndex
or writerIndex
of
this buffer.length
- the maximum number of bytes to transferIOException
- if the specified channel threw an exception during I/Opublic void getBytes(int index, OutputStream out, int length) throws IOException
ChannelBuffer
index
.
This method does not modify readerIndex
or writerIndex
of
this buffer.length
- the number of bytes to transferIOException
- if the specified stream threw an exception during I/Opublic void setByte(int index, int value)
ChannelBuffer
index
in this
buffer. The 24 high-order bits of the specified value are ignored.
This method does not modify readerIndex
or writerIndex
of
this buffer.public void setShort(int index, int value)
ChannelBuffer
index
in this buffer. The 16 high-order bits of the specified
value are ignored.
This method does not modify readerIndex
or writerIndex
of
this buffer.public void setMedium(int index, int value)
ChannelBuffer
index
in this buffer. Please note that the most significant
byte is ignored in the specified value.
This method does not modify readerIndex
or writerIndex
of
this buffer.public void setInt(int index, int value)
ChannelBuffer
index
in this buffer.
This method does not modify readerIndex
or writerIndex
of
this buffer.public void setLong(int index, long value)
ChannelBuffer
index
in this buffer.
This method does not modify readerIndex
or writerIndex
of
this buffer.public void setBytes(int index, byte[] src, int srcIndex, int length)
ChannelBuffer
index
.
This method does not modify readerIndex
or writerIndex
of
this buffer.public void setBytes(int index, ByteBuffer src)
ChannelBuffer
index
until the source buffer's position
reaches its limit.
This method does not modify readerIndex
or writerIndex
of
this buffer.public void setBytes(int index, ChannelBuffer src, int srcIndex, int length)
ChannelBuffer
index
.
This method does not modify readerIndex
or writerIndex
of both the source (i.e. this
) and the destination.srcIndex
- the first index of the sourcelength
- the number of bytes to transferpublic int setBytes(int index, InputStream in, int length) throws IOException
ChannelBuffer
index
.
This method does not modify readerIndex
or writerIndex
of
this buffer.length
- the number of bytes to transfer-1
if the specified channel is closed.IOException
- if the specified stream threw an exception during I/Opublic int setBytes(int index, ScatteringByteChannel in, int length) throws IOException
ChannelBuffer
index
.
This method does not modify readerIndex
or writerIndex
of
this buffer.length
- the maximum number of bytes to transfer-1
if the specified channel is closed.IOException
- if the specified channel threw an exception during I/Opublic ChannelBuffer duplicate()
ChannelBuffer
buf.slice(0, buf.capacity())
.
This method does not modify readerIndex
or writerIndex
of
this buffer.public ChannelBuffer copy(int index, int length)
ChannelBuffer
readerIndex
or writerIndex
of
this buffer.public ChannelBuffer getBuffer(int index)
ChannelBuffer
portion of this CompositeChannelBuffer
that
contains the specified index
. This is an expert method!
Please note that since a CompositeChannelBuffer
is made up of
multiple ChannelBuffer
s, this does not return the full buffer.
Instead, it only returns a portion of the composite buffer where the
index is located
index
- The index
to search for and include in the returned ChannelBuffer
ChannelBuffer
that contains the specified index
IndexOutOfBoundsException
- when the specified index
is
less than zero, or larger than capacity()
public ChannelBuffer slice(int index, int length)
ChannelBuffer
readerIndex
or writerIndex
of
this buffer.public ByteBuffer toByteBuffer(int index, int length)
ChannelBuffer
readerIndex
or writerIndex
of
this buffer.public ByteBuffer[] toByteBuffers(int index, int length)
ChannelBuffer
readerIndex
or writerIndex
of
this buffer.toByteBuffers
in interface ChannelBuffer
toByteBuffers
in class AbstractChannelBuffer
public void discardReadBytes()
ChannelBuffer
readerIndex
.
It moves the bytes between readerIndex
and writerIndex
to the 0th index, and sets readerIndex
and writerIndex
to 0
and oldWriterIndex - oldReaderIndex
respectively.
Please refer to the class documentation for more detailed explanation.
discardReadBytes
in interface ChannelBuffer
discardReadBytes
in class AbstractChannelBuffer
public String toString()
ChannelBuffer
ChannelBuffer.readerIndex()
,
ChannelBuffer.writerIndex()
and ChannelBuffer.capacity()
.toString
in interface ChannelBuffer
toString
in class AbstractChannelBuffer
Copyright © 2008-2013 The Netty Project. All Rights Reserved.