Package org.jboss.netty.buffer
Class DynamicChannelBuffer
java.lang.Object
org.jboss.netty.buffer.AbstractChannelBuffer
org.jboss.netty.buffer.DynamicChannelBuffer
- All Implemented Interfaces:
Comparable<ChannelBuffer>
,ChannelBuffer
A dynamic capacity buffer which increases its capacity as needed. It is
recommended to use
ChannelBuffers.dynamicBuffer(int)
instead of
calling the constructor explicitly.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ChannelBuffer
private final ByteOrder
private final ChannelBufferFactory
-
Constructor Summary
ConstructorsConstructorDescriptionDynamicChannelBuffer
(int estimatedLength) DynamicChannelBuffer
(ByteOrder endianness, int estimatedLength) DynamicChannelBuffer
(ByteOrder endianness, int estimatedLength, ChannelBufferFactory factory) -
Method Summary
Modifier and TypeMethodDescriptionbyte[]
array()
Returns the backing byte array of this buffer.int
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.copy
(int index, int length) Returns a copy of this buffer's sub-region.Returns a buffer which shares the whole region of this buffer.void
ensureWritableBytes
(int minWritableBytes) Makes sure the number of the writable bytes is equal to or greater than the specified value.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, 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.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.slice
(int index, int length) Returns a slice of this buffer's sub-region.toByteBuffer
(int index, int length) Converts this buffer's sub-region into a NIO buffer.void
writeByte
(int value) Sets the specified byte at the currentwriterIndex
and increases thewriterIndex
by1
in this buffer.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
(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
(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
(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, 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
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.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
.Methods inherited from class org.jboss.netty.buffer.AbstractChannelBuffer
bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, checkReadableBytes, clear, compareTo, copy, discardReadBytes, 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, toByteBuffers, toString, toString, toString, writable, writableBytes, writeBytes, writeBytes, writeBytes, writeChar, writeDouble, writeFloat, writerIndex, writerIndex
-
Field Details
-
factory
-
endianness
-
buffer
-
-
Constructor Details
-
DynamicChannelBuffer
public DynamicChannelBuffer(int estimatedLength) -
DynamicChannelBuffer
-
DynamicChannelBuffer
public DynamicChannelBuffer(ByteOrder endianness, int estimatedLength, ChannelBufferFactory factory)
-
-
Method Details
-
ensureWritableBytes
public void ensureWritableBytes(int minWritableBytes) Description copied from interface:ChannelBuffer
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.
- Specified by:
ensureWritableBytes
in interfaceChannelBuffer
- Overrides:
ensureWritableBytes
in classAbstractChannelBuffer
- Parameters:
minWritableBytes
- the expected minimum number of writable bytes
- a non-dynamic buffer will throw an
-
factory
Description copied from interface:ChannelBuffer
Returns the factory which creates aChannelBuffer
whose type and defaultByteOrder
are same with this buffer. -
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. -
capacity
public int capacity()Description copied from interface:ChannelBuffer
Returns the number of bytes (octets) this buffer can contain. -
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. -
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.- Parameters:
dstIndex
- the first index of the destinationlength
- the number of bytes to transfer
-
getBytes
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.- Parameters:
dstIndex
- the first index of the destinationlength
- the number of bytes to transfer
-
getBytes
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
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.- Parameters:
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
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.- Parameters:
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
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.- Parameters:
srcIndex
- the first index of the sourcelength
- the number of bytes to transfer
-
setBytes
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
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.- 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:
IOException
- if the specified stream threw an exception during I/O
-
setBytes
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.- 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:
IOException
- if the specified channel threw an exception during I/O
-
writeByte
public void writeByte(int value) Description copied from interface:ChannelBuffer
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.- Specified by:
writeByte
in interfaceChannelBuffer
- Overrides:
writeByte
in classAbstractChannelBuffer
-
writeShort
public void writeShort(int value) Description copied from interface:ChannelBuffer
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.- Specified by:
writeShort
in interfaceChannelBuffer
- Overrides:
writeShort
in classAbstractChannelBuffer
-
writeMedium
public void writeMedium(int value) Description copied from interface:ChannelBuffer
Sets the specified 24-bit medium integer at the currentwriterIndex
and increases thewriterIndex
by3
in this buffer.- Specified by:
writeMedium
in interfaceChannelBuffer
- Overrides:
writeMedium
in classAbstractChannelBuffer
-
writeInt
public void writeInt(int value) Description copied from interface:ChannelBuffer
Sets the specified 32-bit integer at the currentwriterIndex
and increases thewriterIndex
by4
in this buffer.- Specified by:
writeInt
in interfaceChannelBuffer
- Overrides:
writeInt
in classAbstractChannelBuffer
-
writeLong
public void writeLong(long value) Description copied from interface:ChannelBuffer
Sets the specified 64-bit long integer at the currentwriterIndex
and increases thewriterIndex
by8
in this buffer.- Specified by:
writeLong
in interfaceChannelBuffer
- Overrides:
writeLong
in classAbstractChannelBuffer
-
writeBytes
public void writeBytes(byte[] src, int srcIndex, int length) Description copied from interface:ChannelBuffer
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
).- Specified by:
writeBytes
in interfaceChannelBuffer
- Overrides:
writeBytes
in classAbstractChannelBuffer
- Parameters:
srcIndex
- the first index of the sourcelength
- the number of bytes to transfer
-
writeBytes
Description copied from interface:ChannelBuffer
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
).- Specified by:
writeBytes
in interfaceChannelBuffer
- Overrides:
writeBytes
in classAbstractChannelBuffer
- Parameters:
srcIndex
- the first index of the sourcelength
- the number of bytes to transfer
-
writeBytes
Description copied from interface:ChannelBuffer
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.- Specified by:
writeBytes
in interfaceChannelBuffer
- Overrides:
writeBytes
in classAbstractChannelBuffer
-
writeBytes
Description copied from interface:ChannelBuffer
Transfers the content of the specified stream to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes.- Specified by:
writeBytes
in interfaceChannelBuffer
- Overrides:
writeBytes
in classAbstractChannelBuffer
- Parameters:
length
- the number of bytes to transfer- Returns:
- the actual number of bytes read in from the specified stream
- Throws:
IOException
- if the specified stream threw an exception during I/O
-
writeBytes
Description copied from interface:ChannelBuffer
Transfers the content of the specified channel to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes.- Specified by:
writeBytes
in interfaceChannelBuffer
- Overrides:
writeBytes
in classAbstractChannelBuffer
- Parameters:
length
- the maximum number of bytes to transfer- Returns:
- the actual number of bytes read in from the specified channel
- Throws:
IOException
- if the specified channel threw an exception during I/O
-
writeZero
public void writeZero(int length) Description copied from interface:ChannelBuffer
Fills this buffer with NUL (0x00) starting at the currentwriterIndex
and increases thewriterIndex
by the specifiedlength
.- Specified by:
writeZero
in interfaceChannelBuffer
- Overrides:
writeZero
in classAbstractChannelBuffer
- Parameters:
length
- the number of NULs to write to the buffer
-
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
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. -
slice
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
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.
-