Package org.apache.dubbo.remoting.buffer
Class DynamicChannelBuffer
java.lang.Object
org.apache.dubbo.remoting.buffer.AbstractChannelBuffer
org.apache.dubbo.remoting.buffer.DynamicChannelBuffer
- All Implemented Interfaces:
Comparable<ChannelBuffer>
,ChannelBuffer
-
Constructor Summary
ConstructorDescriptionDynamicChannelBuffer
(int estimatedLength) DynamicChannelBuffer
(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.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 dst, 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.void
getBytes
(int index, ChannelBuffer dst, int dstIndex, int length) Transfers this buffer's data to the specified destination starting at the specified absoluteindex
.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.void
release()
If this buffer is backed by an NIO direct buffer, in some scenarios it may be necessary to manually release.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 src, 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.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
.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.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
).Methods inherited from class org.apache.dubbo.remoting.buffer.AbstractChannelBuffer
clear, compareTo, copy, discardReadBytes, equals, getBytes, getBytes, getBytes, hashCode, markReaderIndex, markWriterIndex, readable, readableBytes, readByte, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readerIndex, readerIndex, resetReaderIndex, resetWriterIndex, setBytes, setBytes, setBytes, setIndex, skipBytes, toByteBuffer, toString, writable, writableBytes, writeBytes, writeBytes, writeBytes, writerIndex, writerIndex
-
Constructor Details
-
DynamicChannelBuffer
public DynamicChannelBuffer(int estimatedLength) -
DynamicChannelBuffer
-
-
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
-
capacity
public int capacity()Description copied from interface:ChannelBuffer
Returns the number of bytes (octets) this buffer can contain. -
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. -
factory
Description copied from interface:ChannelBuffer
Returns the factory which creates aChannelBuffer
whose type and defaultByteOrder
are same with 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. -
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
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 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 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
-
isDirect
public boolean isDirect()Description copied from interface:ChannelBuffer
Returnstrue
if and only if this buffer is backed by an NIO direct buffer. -
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. -
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
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 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 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
-
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. -
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
-
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
-
array
public byte[] array()Description copied from interface:ChannelBuffer
Returns the backing byte array of this 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()
. -
arrayOffset
public int arrayOffset()Description copied from interface:ChannelBuffer
Returns the offset of the first byte within the backing byte array of this buffer. -
release
public void release()Description copied from interface:ChannelBuffer
If this buffer is backed by an NIO direct buffer, in some scenarios it may be necessary to manually release.
-