Package org.jboss.netty.buffer
Class CompositeChannelBuffer
- java.lang.Object
-
- org.jboss.netty.buffer.AbstractChannelBuffer
-
- org.jboss.netty.buffer.CompositeChannelBuffer
-
- All Implemented Interfaces:
Comparable<ChannelBuffer>
,ChannelBuffer
public class CompositeChannelBuffer extends AbstractChannelBuffer
A virtual buffer which shows multiple buffers as a single merged buffer. It is recommended to useChannelBuffers.wrappedBuffer(ChannelBuffer...)
instead of calling the constructor explicitly.
-
-
Constructor Summary
Constructors Constructor Description CompositeChannelBuffer(ByteOrder endianness, List<ChannelBuffer> buffers, boolean gathering)
-
Method Summary
All Methods Instance Methods Concrete 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
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 withslice(int, int)
except that this method returns a list.void
discardReadBytes()
Discards the bytes between the 0th index andreaderIndex
.ChannelBuffer
duplicate()
Returns a buffer which shares the whole region of this buffer.ChannelBufferFactory
factory()
Returns the factory which creates aChannelBuffer
whose type and defaultByteOrder
are same with this buffer.ChannelBuffer
getBuffer(int index)
byte
getByte(int index)
Gets a byte at the specified absoluteindex
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 absoluteindex
.void
getBytes(int index, OutputStream out, int length)
Transfers this buffer's data to the specified stream starting at the specified absoluteindex
.void
getBytes(int index, 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, GatheringByteChannel out, int length)
Transfers this buffer's data to the specified channel 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
.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.short
getShort(int index)
Gets a 16-bit short 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.boolean
hasArray()
Returnstrue
if and only if this buffer has a backing byte array.boolean
isDirect()
Returnstrue
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 absoluteindex
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 absoluteindex
.int
setBytes(int index, InputStream in, int length)
Transfers the content of the specified source stream to this buffer starting at the specified absoluteindex
.void
setBytes(int index, 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, 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, int srcIndex, int length)
Transfers the specified source buffer's data to this buffer starting at the specified absoluteindex
.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.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()
Returntrue
if gathering writes / reads should be used for thisCompositeChannelBuffer
-
Methods inherited from class org.jboss.netty.buffer.AbstractChannelBuffer
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, readChar, readDouble, readerIndex, readerIndex, readFloat, readInt, readLong, readMedium, readShort, readSlice, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, resetReaderIndex, resetWriterIndex, setBytes, setBytes, setBytes, setChar, setDouble, setFloat, setIndex, setZero, skipBytes, slice, toByteBuffer, toByteBuffers, toString, toString, writable, writableBytes, writeByte, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writerIndex, writerIndex, writeShort, writeZero
-
-
-
-
Constructor Detail
-
CompositeChannelBuffer
public CompositeChannelBuffer(ByteOrder endianness, List<ChannelBuffer> buffers, boolean gathering)
-
-
Method Detail
-
useGathering
public boolean useGathering()
Returntrue
if gathering writes / reads should be used for thisCompositeChannelBuffer
-
decompose
public List<ChannelBuffer> decompose(int index, int length)
Same withslice(int, int)
except that this method returns a list.
-
factory
public ChannelBufferFactory factory()
Description copied from interface:ChannelBuffer
Returns the factory which creates aChannelBuffer
whose type and defaultByteOrder
are same with this buffer.
-
order
public ByteOrder order()
Description copied from interface:ChannelBuffer
Returns the endianness of this buffer.
-
isDirect
public boolean isDirect()
Description copied from interface:ChannelBuffer
Returnstrue
if and only if this buffer is backed by an NIO direct buffer.
-
hasArray
public boolean hasArray()
Description copied from interface:ChannelBuffer
Returnstrue
if and only if this buffer has a backing byte array. If this method returns true, you can safely callChannelBuffer.array()
andChannelBuffer.arrayOffset()
.
-
array
public byte[] array()
Description copied from interface:ChannelBuffer
Returns the backing byte array of this buffer.
-
arrayOffset
public int arrayOffset()
Description copied from interface:ChannelBuffer
Returns the offset of the first byte within the backing byte array of this buffer.
-
capacity
public int capacity()
Description copied from interface:ChannelBuffer
Returns the number of bytes (octets) this buffer can contain.
-
numComponents
public int numComponents()
-
getByte
public byte getByte(int index)
Description copied from interface:ChannelBuffer
Gets a byte at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
getShort
public short getShort(int index)
Description copied from interface:ChannelBuffer
Gets a 16-bit short integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
getUnsignedMedium
public int getUnsignedMedium(int index)
Description copied from interface:ChannelBuffer
Gets an unsigned 24-bit medium integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
getInt
public int getInt(int index)
Description copied from interface:ChannelBuffer
Gets a 32-bit integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
getLong
public long getLong(int index)
Description copied from interface:ChannelBuffer
Gets a 64-bit long integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
getBytes
public void getBytes(int index, byte[] dst, int dstIndex, int length)
Description copied from interface:ChannelBuffer
Transfers this buffer's data to the specified destination starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.dstIndex
- the first index of the destinationlength
- the number of bytes to transfer
-
getBytes
public void getBytes(int index, ByteBuffer dst)
Description copied from interface:ChannelBuffer
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.
-
getBytes
public void getBytes(int index, ChannelBuffer dst, int dstIndex, int length)
Description copied from interface:ChannelBuffer
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.dstIndex
- the first index of the destinationlength
- the number of bytes to transfer
-
getBytes
public int getBytes(int index, GatheringByteChannel out, int length) throws IOException
Description copied from interface:ChannelBuffer
Transfers this buffer's data to the specified channel starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.length
- the maximum number of bytes to transfer- Returns:
- the actual number of bytes written out to the specified channel
- Throws:
IOException
- if the specified channel threw an exception during I/O
-
getBytes
public void getBytes(int index, OutputStream out, int length) throws IOException
Description copied from interface:ChannelBuffer
Transfers this buffer's data to the specified stream starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.length
- the number of bytes to transfer- Throws:
IOException
- if the specified stream threw an exception during I/O
-
setByte
public void setByte(int index, int value)
Description copied from interface:ChannelBuffer
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.
-
setShort
public void setShort(int index, int value)
Description copied from interface:ChannelBuffer
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.
-
setMedium
public void setMedium(int index, int value)
Description copied from interface:ChannelBuffer
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.
-
setInt
public void setInt(int index, int value)
Description copied from interface:ChannelBuffer
Sets the specified 32-bit integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
setLong
public void setLong(int index, long value)
Description copied from interface:ChannelBuffer
Sets the specified 64-bit long integer at the specified absoluteindex
in this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
setBytes
public void setBytes(int index, byte[] src, int srcIndex, int length)
Description copied from interface:ChannelBuffer
Transfers the specified source array's data to this buffer starting at the specified absoluteindex
. This method does not modifyreaderIndex
orwriterIndex
of this buffer.
-
setBytes
public void setBytes(int index, ByteBuffer src)
Description copied from interface:ChannelBuffer
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.
-
setBytes
public void setBytes(int index, ChannelBuffer src, int srcIndex, int length)
Description copied from interface:ChannelBuffer
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.srcIndex
- the first index of the sourcelength
- the number of bytes to transfer
-
setBytes
public int setBytes(int index, InputStream in, int length) throws IOException
Description copied from interface:ChannelBuffer
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.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:
IOException
- if the specified stream threw an exception during I/O
-
setBytes
public int setBytes(int index, ScatteringByteChannel in, int length) throws IOException
Description copied from interface:ChannelBuffer
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.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:
IOException
- if the specified channel threw an exception during I/O
-
duplicate
public ChannelBuffer duplicate()
Description copied from interface:ChannelBuffer
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.
-
copy
public ChannelBuffer copy(int index, int length)
Description copied from interface:ChannelBuffer
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.
-
getBuffer
public ChannelBuffer getBuffer(int index)
Returns theChannelBuffer
portion of thisCompositeChannelBuffer
that contains the specifiedindex
. This is an expert method!Please note that since a
CompositeChannelBuffer
is made up of multipleChannelBuffer
s, this does not return the full buffer. Instead, it only returns a portion of the composite buffer where the index is located- Parameters:
index
- Theindex
to search for and include in the returnedChannelBuffer
- Returns:
- The
ChannelBuffer
that contains the specifiedindex
- Throws:
IndexOutOfBoundsException
- when the specifiedindex
is less than zero, or larger thancapacity()
-
slice
public ChannelBuffer slice(int index, int length)
Description copied from interface:ChannelBuffer
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.
-
toByteBuffer
public ByteBuffer toByteBuffer(int index, int length)
Description copied from interface:ChannelBuffer
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
public ByteBuffer[] toByteBuffers(int index, int length)
Description copied from interface:ChannelBuffer
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.- Specified by:
toByteBuffers
in interfaceChannelBuffer
- Overrides:
toByteBuffers
in classAbstractChannelBuffer
-
discardReadBytes
public void discardReadBytes()
Description copied from interface:ChannelBuffer
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.
- Specified by:
discardReadBytes
in interfaceChannelBuffer
- Overrides:
discardReadBytes
in classAbstractChannelBuffer
-
toString
public String toString()
Description copied from interface:ChannelBuffer
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 asChannelBuffer.readerIndex()
,ChannelBuffer.writerIndex()
andChannelBuffer.capacity()
.- Specified by:
toString
in interfaceChannelBuffer
- Overrides:
toString
in classAbstractChannelBuffer
-
-