Netty/Buffer 4.1.107.Final · io.netty.buffer.PooledByteBuf

Modifier and Type	Field and Description
private ByteBufAllocator	allocator
pack-priv PoolThreadCache	cache
protected PoolChunk<T>	chunk
protected long	handle
protected int	length
pack-priv int	maxLength
protected T	memory
protected int	offset
private final Recycler.EnhancedHandle<PooledByteBuf<T>>	recyclerHandle
pack-priv ByteBuffer	tmpNioBuf

Access	Constructor and Description
protected	PooledByteBuf(ObjectPool.Handle<? extends PooledByteBuf<T>> recyclerHandle, int maxCapacity)

Method Summary

Modifier and Type	Method and Description
pack-priv final ByteBuffer	_internalNioBuffer(int index, int length, boolean duplicate)
public final ByteBufAllocator	alloc() Implements abstract io.netty.buffer.ByteBuf.alloc. Returns the `ByteBufAllocator` which created this buffer.
public final int	capacity() Implements abstract io.netty.buffer.ByteBuf.capacity. Returns the number of bytes (octets) this buffer can contain.
public final ByteBuf	capacity(int newCapacity) Implements abstract io.netty.buffer.ByteBuf.capacity. Adjusts the capacity of this buffer.
protected final void	deallocate() Implements abstract io.netty.buffer.AbstractReferenceCountedByteBuf.deallocate. Called once `refCnt()` is equals 0.
pack-priv ByteBuffer	duplicateInternalNioBuffer(int index, int length)
public final int	getBytes(int index, GatheringByteChannel out, int the maximum number of bytes to transfer length) Implements abstract io.netty.buffer.ByteBuf.getBytes. Transfers this buffer's data to the specified channel starting at the specified absolute `index`.
public final int	getBytes(int index, FileChannel out, long the file position at which the transfer is to begin position, int the maximum number of bytes to transfer length) Implements abstract io.netty.buffer.ByteBuf.getBytes. Transfers this buffer's data starting at the specified absolute `index` to the specified channel starting at the given file position.
protected final int	idx(int index)
pack-priv void	init(PoolChunk<T> chunk, ByteBuffer nioBuffer, long handle, int offset, int length, int maxLength, PoolThreadCache cache)
private void	init0(PoolChunk<T> chunk, ByteBuffer nioBuffer, long handle, int offset, int length, int maxLength, PoolThreadCache cache)
pack-priv void	initUnpooled(PoolChunk<T> chunk, int length)
protected final ByteBuffer	internalNioBuffer()
public final ByteBuffer	internalNioBuffer(int index, int length) Implements abstract io.netty.buffer.ByteBuf.internalNioBuffer. Internal use only: Exposes the internal NIO buffer.
public final boolean	isContiguous() Overrides io.netty.buffer.ByteBuf.isContiguous. Returns `true` if this `ByteBuf` implementation is backed by a single memory region.
public int	maxFastWritableBytes() Overrides io.netty.buffer.ByteBuf.maxFastWritableBytes. Returns the maximum number of bytes which can be written for certain without involving an internal reallocation or data-copy.
protected abstract ByteBuffer	newInternalNioBuffer(T memory)
public final ByteBuffer	nioBuffer(int index, int length) Implements abstract io.netty.buffer.ByteBuf.nioBuffer. Exposes this buffer's sub-region as an NIO `ByteBuffer`.
public final int	nioBufferCount() Implements abstract io.netty.buffer.ByteBuf.nioBufferCount. Returns the maximum number of NIO `ByteBuffer`s that consist this buffer.
public final ByteBuffer[]	nioBuffers(int index, int length) Implements abstract io.netty.buffer.ByteBuf.nioBuffers. Exposes this buffer's bytes as an NIO `ByteBuffer`'s for the specified index and length The returned buffer either share or contains the copied content of this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer.
public final ByteOrder	order() Implements abstract io.netty.buffer.ByteBuf.order. Returns the endianness of this buffer.
public final int	readBytes(GatheringByteChannel out, int the maximum number of bytes to transfer length) Overrides io.netty.buffer.AbstractByteBuf.readBytes. Transfers this buffer's data to the specified stream starting at the current `readerIndex`.
public final int	readBytes(FileChannel out, long the file position at which the transfer is to begin position, int the maximum number of bytes to transfer length) Overrides io.netty.buffer.AbstractByteBuf.readBytes. Transfers this buffer's data starting at the current `readerIndex` to the specified channel starting at the given file position.
public final ByteBuf	retainedDuplicate() Overrides io.netty.buffer.AbstractByteBuf.retainedDuplicate. Returns a retained buffer which shares the whole region of this buffer.
public final ByteBuf	retainedSlice() Overrides io.netty.buffer.AbstractByteBuf.retainedSlice. Returns a retained slice of this buffer's readable bytes.
public final ByteBuf	retainedSlice(int index, int length) Overrides io.netty.buffer.AbstractByteBuf.retainedSlice. Returns a retained slice of this buffer's sub-region.
pack-priv final void	reuse(int maxCapacity) Method must be called before reuse this `PooledByteBufAllocator`
public final int	setBytes(int index, ScatteringByteChannel in, int the maximum number of bytes to transfer length) Implements abstract io.netty.buffer.ByteBuf.setBytes. Transfers the content of the specified source channel to this buffer starting at the specified absolute `index`.
public final int	setBytes(int index, FileChannel in, long the file position at which the transfer is to begin position, int the maximum number of bytes to transfer length) Implements abstract io.netty.buffer.ByteBuf.setBytes. Transfers the content of the specified source channel starting at the given file position to this buffer starting at the specified absolute `index`.
public final ByteBuf	unwrap() Implements abstract io.netty.buffer.ByteBuf.unwrap. Return the underlying buffer instance if this buffer is a wrapper of another buffer.

Inherited from io.netty.buffer.AbstractReferenceCountedByteBuf:: isAccessible refCnt release release resetRefCnt retain retain setRefCnt touch touch

allocator	back to summary
private ByteBufAllocator allocator

cache	back to summary
pack-priv PoolThreadCache cache

chunk	back to summary
protected PoolChunk<T> chunk

handle	back to summary
protected long handle

length	back to summary
protected int length

maxLength	back to summary
pack-priv int maxLength

memory	back to summary
protected T memory

offset	back to summary
protected int offset

recyclerHandle	back to summary
private final Recycler.EnhancedHandle<PooledByteBuf<T>> recyclerHandle

tmpNioBuf	back to summary
pack-priv ByteBuffer tmpNioBuf

PooledByteBuf	back to summary
protected PooledByteBuf(ObjectPool.Handle<? extends PooledByteBuf<T>> recyclerHandle, int maxCapacity) Annotations @SuppressWarnings:unchecked

Method Detail

_internalNioBuffer	back to summary
pack-priv final ByteBuffer _internalNioBuffer(int index, int length, boolean duplicate)

alloc back to summary

alloc	back to summary
public final ByteBufAllocator alloc() Implements abstract io.netty.buffer.ByteBuf.alloc. Doc from io.netty.buffer.ByteBuf.alloc. Returns the `ByteBufAllocator` which created this buffer. Annotations @Override

public final ByteBufAllocator alloc()

Implements abstract io.netty.buffer.ByteBuf.alloc.

Doc from io.netty.buffer.ByteBuf.alloc.

Returns the ByteBufAllocator which created this buffer.

Annotations

@Override

capacity	back to summary
public final int capacity() Implements abstract io.netty.buffer.ByteBuf.capacity. Doc from io.netty.buffer.ByteBuf.capacity. Returns the number of bytes (octets) this buffer can contain. Annotations @Override

capacity

back to summary

public final int capacity()

Implements abstract io.netty.buffer.ByteBuf.capacity.

Doc from io.netty.buffer.ByteBuf.capacity.

Returns the number of bytes (octets) this buffer can contain.

Annotations

@Override

capacity back to summary

capacity	back to summary
public final ByteBuf capacity(int newCapacity) Implements abstract io.netty.buffer.ByteBuf.capacity. Doc from io.netty.buffer.ByteBuf.capacity. Adjusts the capacity of this buffer. If the `newCapacity` is less than the current capacity, the content of this buffer is truncated. If the `newCapacity` is greater than the current capacity, the buffer is appended with unspecified data whose length is `(newCapacity - currentCapacity)`. Annotations @Override

public final ByteBuf capacity(int newCapacity)

Implements abstract io.netty.buffer.ByteBuf.capacity.

Doc from io.netty.buffer.ByteBuf.capacity.

Adjusts the capacity of this buffer. If the newCapacity is less than the current capacity, the content of this buffer is truncated. If the newCapacity is greater than the current capacity, the buffer is appended with unspecified data whose length is (newCapacity - currentCapacity).

Annotations

@Override

deallocate back to summary

deallocate	back to summary
protected final void deallocate() Implements abstract io.netty.buffer.AbstractReferenceCountedByteBuf.deallocate. Doc from io.netty.buffer.AbstractReferenceCountedByteBuf.deallocate. Called once `refCnt()` is equals 0. Annotations @Override

protected final void deallocate()

Implements abstract io.netty.buffer.AbstractReferenceCountedByteBuf.deallocate.

Doc from io.netty.buffer.AbstractReferenceCountedByteBuf.deallocate.

Called once refCnt() is equals 0.

Annotations

@Override

duplicateInternalNioBuffer	back to summary
pack-priv ByteBuffer duplicateInternalNioBuffer(int index, int length)

getBytes back to summary

getBytes	back to summary
public final int getBytes(int index, GatheringByteChannel out, int length) throws IOException Implements abstract io.netty.buffer.ByteBuf.getBytes. Doc from io.netty.buffer.ByteBuf.getBytes. Transfers this buffer's data to the specified channel starting at the specified absolute `index`. This method does not modify `readerIndex` or `writerIndex` of this buffer. Parameters length:int the maximum number of bytes to transfer Returns:int the actual number of bytes written out to the specified channel Annotations @Override Exceptions IOException: if the specified channel threw an exception during I/O

public final int getBytes(int index, GatheringByteChannel out, int length) throws IOException

Implements abstract io.netty.buffer.ByteBuf.getBytes.

Doc from io.netty.buffer.ByteBuf.getBytes.

Transfers this buffer's data to the specified channel starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.

Parameters

length:int: the maximum number of bytes to transfer

Returns:int

the actual number of bytes written out to the specified channel

Annotations

@Override

Exceptions

IOException:: if the specified channel threw an exception during I/O

getBytes back to summary

getBytes	back to summary
public final int getBytes(int index, FileChannel out, long position, int length) throws IOException Implements abstract io.netty.buffer.ByteBuf.getBytes. Doc from io.netty.buffer.ByteBuf.getBytes. Transfers this buffer's data starting at the specified absolute `index` to the specified channel starting at the given file position. This method does not modify `readerIndex` or `writerIndex` of this buffer. This method does not modify the channel's position. Parameters position:long the file position at which the transfer is to begin length:int the maximum number of bytes to transfer Returns:int the actual number of bytes written out to the specified channel Annotations @Override Exceptions IOException: if the specified channel threw an exception during I/O

public final int getBytes(int index, FileChannel out, long position, int length) throws IOException

Implements abstract io.netty.buffer.ByteBuf.getBytes.

Doc from io.netty.buffer.ByteBuf.getBytes.

Transfers this buffer's data starting at the specified absolute index to the specified channel starting at the given file position. This method does not modify readerIndex or writerIndex of this buffer. This method does not modify the channel's position.

Parameters

position:long: the file position at which the transfer is to begin
length:int: the maximum number of bytes to transfer

Returns:int

the actual number of bytes written out to the specified channel

Annotations

@Override

Exceptions

IOException:: if the specified channel threw an exception during I/O

idx	back to summary
protected final int idx(int index)

init	back to summary
pack-priv void init(PoolChunk<T> chunk, ByteBuffer nioBuffer, long handle, int offset, int length, int maxLength, PoolThreadCache cache)

init0	back to summary
private void init0(PoolChunk<T> chunk, ByteBuffer nioBuffer, long handle, int offset, int length, int maxLength, PoolThreadCache cache)

initUnpooled	back to summary
pack-priv void initUnpooled(PoolChunk<T> chunk, int length)

internalNioBuffer	back to summary
protected final ByteBuffer internalNioBuffer()

internalNioBuffer	back to summary
public final ByteBuffer internalNioBuffer(int index, int length) Implements abstract io.netty.buffer.ByteBuf.internalNioBuffer. Doc from io.netty.buffer.ByteBuf.internalNioBuffer. Internal use only: Exposes the internal NIO buffer. Annotations @Override

internalNioBuffer

back to summary

public final ByteBuffer internalNioBuffer(int index, int length)

Implements abstract io.netty.buffer.ByteBuf.internalNioBuffer.

Doc from io.netty.buffer.ByteBuf.internalNioBuffer.

Internal use only: Exposes the internal NIO buffer.

Annotations

@Override

isContiguous back to summary

isContiguous	back to summary
public final boolean isContiguous() Overrides io.netty.buffer.ByteBuf.isContiguous. Doc from io.netty.buffer.ByteBuf.isContiguous. Returns `true` if this `ByteBuf` implementation is backed by a single memory region. Composite buffer implementations must return false even if they currently hold ≤ 1 components. For buffers that return `true`, it's guaranteed that a successful call to `discardReadBytes()` will increase the value of `maxFastWritableBytes()` by the current `readerIndex`. This method will return `false` by default, and a `false` return value does not necessarily mean that the implementation is composite or that it is not backed by a single memory region. Annotations @Override

public final boolean isContiguous()

Overrides io.netty.buffer.ByteBuf.isContiguous.

Doc from io.netty.buffer.ByteBuf.isContiguous.

Returns true if this ByteBuf implementation is backed by a single memory region. Composite buffer implementations must return false even if they currently hold ≤ 1 components. For buffers that return true, it's guaranteed that a successful call to discardReadBytes() will increase the value of maxFastWritableBytes() by the current readerIndex.

This method will return false by default, and a false return value does not necessarily mean that the implementation is composite or that it is not backed by a single memory region.

Annotations

@Override

maxFastWritableBytes back to summary

maxFastWritableBytes	back to summary
public int maxFastWritableBytes() Overrides io.netty.buffer.ByteBuf.maxFastWritableBytes. Doc from io.netty.buffer.ByteBuf.maxFastWritableBytes. Returns the maximum number of bytes which can be written for certain without involving an internal reallocation or data-copy. The returned value will be ≥ `writableBytes()` and ≤ `maxWritableBytes()`. Annotations @Override

public int maxFastWritableBytes()

Overrides io.netty.buffer.ByteBuf.maxFastWritableBytes.

Doc from io.netty.buffer.ByteBuf.maxFastWritableBytes.

Returns the maximum number of bytes which can be written for certain without involving an internal reallocation or data-copy. The returned value will be ≥ writableBytes() and ≤ maxWritableBytes().

Annotations

@Override

newInternalNioBuffer	back to summary
protected abstract ByteBuffer newInternalNioBuffer(T memory)

nioBuffer back to summary

nioBuffer	back to summary
public final ByteBuffer nioBuffer(int index, int length) Implements abstract io.netty.buffer.ByteBuf.nioBuffer. Doc from io.netty.buffer.ByteBuf.nioBuffer. Exposes this buffer's sub-region as an NIO `ByteBuffer`. The returned buffer either share or contains the copied content of this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method does not modify `readerIndex` or `writerIndex` of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity. Annotations @Override

public final ByteBuffer nioBuffer(int index, int length)

Implements abstract io.netty.buffer.ByteBuf.nioBuffer.

Doc from io.netty.buffer.ByteBuf.nioBuffer.

Exposes this buffer's sub-region as an NIO ByteBuffer. The returned buffer either share or contains the copied content of this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method does not modify readerIndex or writerIndex of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity.

Annotations

@Override

nioBufferCount back to summary

nioBufferCount	back to summary
public final int nioBufferCount() Implements abstract io.netty.buffer.ByteBuf.nioBufferCount. Doc from io.netty.buffer.ByteBuf.nioBufferCount. Returns the maximum number of NIO `ByteBuffer`s that consist this buffer. Note that `nioBuffers()` or `nioBuffers(int, int)` might return a less number of `ByteBuffer`s. Returns:int `-1` if this buffer has no underlying `ByteBuffer`. the number of the underlying `ByteBuffer`s if this buffer has at least one underlying `ByteBuffer`. Note that this method does not return `0` to avoid confusion. Annotations @Override

public final int nioBufferCount()

Implements abstract io.netty.buffer.ByteBuf.nioBufferCount.

Doc from io.netty.buffer.ByteBuf.nioBufferCount.

Returns the maximum number of NIO ByteBuffers that consist this buffer. Note that nioBuffers() or nioBuffers(int, int) might return a less number of ByteBuffers.

Returns:int

-1 if this buffer has no underlying ByteBuffer. the number of the underlying ByteBuffers if this buffer has at least one underlying ByteBuffer. Note that this method does not return 0 to avoid confusion.

Annotations

@Override

nioBuffers back to summary

nioBuffers	back to summary
public final ByteBuffer[] nioBuffers(int index, int length) Implements abstract io.netty.buffer.ByteBuf.nioBuffers. Doc from io.netty.buffer.ByteBuf.nioBuffers. Exposes this buffer's bytes as an NIO `ByteBuffer`'s for the specified index and length The returned buffer either share or contains the copied content of this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method does not modify `readerIndex` or `writerIndex` of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity. Annotations @Override

public final ByteBuffer[] nioBuffers(int index, int length)

Implements abstract io.netty.buffer.ByteBuf.nioBuffers.

Doc from io.netty.buffer.ByteBuf.nioBuffers.

Exposes this buffer's bytes as an NIO ByteBuffer's for the specified index and length The returned buffer either share or contains the copied content of this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method does not modify readerIndex or writerIndex of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity.

Annotations

@Override

order	back to summary
public final ByteOrder order() Implements abstract io.netty.buffer.ByteBuf.order. Doc from io.netty.buffer.ByteBuf.order. Returns the endianness of this buffer. Annotations @Override

order

back to summary

public final ByteOrder order()

Implements abstract io.netty.buffer.ByteBuf.order.

Doc from io.netty.buffer.ByteBuf.order.

Returns the endianness of this buffer.

Annotations

@Override

readBytes back to summary

readBytes	back to summary
public final int readBytes(GatheringByteChannel out, int length) throws IOException Overrides io.netty.buffer.AbstractByteBuf.readBytes. Doc from io.netty.buffer.ByteBuf.readBytes. Transfers this buffer's data to the specified stream starting at the current `readerIndex`. Parameters length:int the maximum number of bytes to transfer Returns:int the actual number of bytes written out to the specified channel Annotations @Override Exceptions IOException: if the specified channel threw an exception during I/O

public final int readBytes(GatheringByteChannel out, int length) throws IOException

Overrides io.netty.buffer.AbstractByteBuf.readBytes.

Doc from io.netty.buffer.ByteBuf.readBytes.

Transfers this buffer's data to the specified stream starting at the current readerIndex.

Parameters

length:int: the maximum number of bytes to transfer

Returns:int

the actual number of bytes written out to the specified channel

Annotations

@Override

Exceptions

IOException:: if the specified channel threw an exception during I/O

readBytes back to summary

readBytes	back to summary
public final int readBytes(FileChannel out, long position, int length) throws IOException Overrides io.netty.buffer.AbstractByteBuf.readBytes. Doc from io.netty.buffer.ByteBuf.readBytes. Transfers this buffer's data starting at the current `readerIndex` to the specified channel starting at the given file position. This method does not modify the channel's position. Parameters position:long the file position at which the transfer is to begin length:int the maximum number of bytes to transfer Returns:int the actual number of bytes written out to the specified channel Annotations @Override Exceptions IOException: if the specified channel threw an exception during I/O

public final int readBytes(FileChannel out, long position, int length) throws IOException

Overrides io.netty.buffer.AbstractByteBuf.readBytes.

Doc from io.netty.buffer.ByteBuf.readBytes.

Transfers this buffer's data starting at the current readerIndex to the specified channel starting at the given file position. This method does not modify the channel's position.

Parameters

position:long: the file position at which the transfer is to begin
length:int: the maximum number of bytes to transfer

Returns:int

the actual number of bytes written out to the specified channel

Annotations

@Override

Exceptions

IOException:: if the specified channel threw an exception during I/O

retainedDuplicate back to summary

retainedDuplicate	back to summary
public final ByteBuf retainedDuplicate() Overrides io.netty.buffer.AbstractByteBuf.retainedDuplicate. Doc from io.netty.buffer.ByteBuf.retainedDuplicate. Returns a retained 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 to `buf.slice(0, buf.capacity())`. This method does not modify `readerIndex` or `writerIndex` of this buffer. Note that this method returns a retained buffer unlike `slice(int, int)`. This method behaves similarly to `duplicate().retain()` except that this method may return a buffer implementation that produces less garbage. Annotations @Override

public final ByteBuf retainedDuplicate()

Overrides io.netty.buffer.AbstractByteBuf.retainedDuplicate.

Doc from io.netty.buffer.ByteBuf.retainedDuplicate.

Returns a retained 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 to buf.slice(0, buf.capacity()). This method does not modify readerIndex or writerIndex of this buffer.

Note that this method returns a retained buffer unlike slice(int, int). This method behaves similarly to duplicate().retain() except that this method may return a buffer implementation that produces less garbage.

Annotations

@Override

retainedSlice back to summary

retainedSlice	back to summary
public final ByteBuf retainedSlice() Overrides io.netty.buffer.AbstractByteBuf.retainedSlice. Doc from io.netty.buffer.ByteBuf.retainedSlice. Returns a retained 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 to `buf.slice(buf.readerIndex(), buf.readableBytes())`. This method does not modify `readerIndex` or `writerIndex` of this buffer. Note that this method returns a retained buffer unlike `slice()`. This method behaves similarly to `slice().retain()` except that this method may return a buffer implementation that produces less garbage. Annotations @Override

public final ByteBuf retainedSlice()

Overrides io.netty.buffer.AbstractByteBuf.retainedSlice.

Doc from io.netty.buffer.ByteBuf.retainedSlice.

Returns a retained 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 to buf.slice(buf.readerIndex(), buf.readableBytes()). This method does not modify readerIndex or writerIndex of this buffer.

Note that this method returns a retained buffer unlike slice(). This method behaves similarly to slice().retain() except that this method may return a buffer implementation that produces less garbage.

Annotations

@Override

retainedSlice back to summary

retainedSlice	back to summary
public final ByteBuf retainedSlice(int index, int length) Overrides io.netty.buffer.AbstractByteBuf.retainedSlice. Doc from io.netty.buffer.ByteBuf.retainedSlice. Returns a retained 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 modify `readerIndex` or `writerIndex` of this buffer. Note that this method returns a retained buffer unlike `slice(int, int)`. This method behaves similarly to `slice(...).retain()` except that this method may return a buffer implementation that produces less garbage. Annotations @Override

public final ByteBuf retainedSlice(int index, int length)

Overrides io.netty.buffer.AbstractByteBuf.retainedSlice.

Doc from io.netty.buffer.ByteBuf.retainedSlice.

Returns a retained 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 modify readerIndex or writerIndex of this buffer.

Note that this method returns a retained buffer unlike slice(int, int). This method behaves similarly to slice(...).retain() except that this method may return a buffer implementation that produces less garbage.

Annotations

@Override

reuse	back to summary
pack-priv final void reuse(int maxCapacity) Method must be called before reuse this `PooledByteBufAllocator`

setBytes back to summary

setBytes	back to summary
public final int setBytes(int index, ScatteringByteChannel in, int length) throws IOException Implements abstract io.netty.buffer.ByteBuf.setBytes. Doc from io.netty.buffer.ByteBuf.setBytes. Transfers the content of the specified source channel to this buffer starting at the specified absolute `index`. This method does not modify `readerIndex` or `writerIndex` of this buffer. Parameters length:int the maximum number of bytes to transfer Returns:int the actual number of bytes read in from the specified channel. `-1` if the specified channel is closed or it reached EOF. Annotations @Override Exceptions IOException: if the specified channel threw an exception during I/O

public final int setBytes(int index, ScatteringByteChannel in, int length) throws IOException

Implements abstract io.netty.buffer.ByteBuf.setBytes.

Doc from io.netty.buffer.ByteBuf.setBytes.

Transfers the content of the specified source channel to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.

Parameters

length:int: the maximum number of bytes to transfer

Returns:int

the actual number of bytes read in from the specified channel. -1 if the specified channel is closed or it reached EOF.

Annotations

@Override

Exceptions

IOException:: if the specified channel threw an exception during I/O

setBytes back to summary

setBytes	back to summary
public final int setBytes(int index, FileChannel in, long position, int length) throws IOException Implements abstract io.netty.buffer.ByteBuf.setBytes. Doc from io.netty.buffer.ByteBuf.setBytes. Transfers the content of the specified source channel starting at the given file position to this buffer starting at the specified absolute `index`. This method does not modify `readerIndex` or `writerIndex` of this buffer. This method does not modify the channel's position. Parameters position:long the file position at which the transfer is to begin length:int the maximum number of bytes to transfer Returns:int the actual number of bytes read in from the specified channel. `-1` if the specified channel is closed or it reached EOF. Annotations @Override Exceptions IOException: if the specified channel threw an exception during I/O

public final int setBytes(int index, FileChannel in, long position, int length) throws IOException

Implements abstract io.netty.buffer.ByteBuf.setBytes.

Doc from io.netty.buffer.ByteBuf.setBytes.

Transfers the content of the specified source channel starting at the given file position to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer. This method does not modify the channel's position.

Parameters

position:long: the file position at which the transfer is to begin
length:int: the maximum number of bytes to transfer

Returns:int

the actual number of bytes read in from the specified channel. -1 if the specified channel is closed or it reached EOF.

Annotations

@Override

Exceptions

IOException:: if the specified channel threw an exception during I/O

unwrap back to summary

unwrap	back to summary
public final ByteBuf unwrap() Implements abstract io.netty.buffer.ByteBuf.unwrap. Doc from io.netty.buffer.ByteBuf.unwrap. Return the underlying buffer instance if this buffer is a wrapper of another buffer. Returns:ByteBuf `null` if this buffer is not a wrapper Annotations @Override

public final ByteBuf unwrap()

Implements abstract io.netty.buffer.ByteBuf.unwrap.

Doc from io.netty.buffer.ByteBuf.unwrap.

Return the underlying buffer instance if this buffer is a wrapper of another buffer.

Returns:ByteBuf

null if this buffer is not a wrapper

Annotations

@Override

pack-priv abstract Class PooledByteBuf<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail