io.netty.buffer

Class AbstractDerivedByteBuf

java.lang.Object

io.netty.buffer.ByteBuf

io.netty.buffer.AbstractByteBuf

io.netty.buffer.AbstractDerivedByteBuf

All Implemented Interfaces:

ReferenceCounted, Comparable<ByteBuf>

Direct Known Subclasses:

DuplicatedByteBuf, ReadOnlyByteBuf, SlicedByteBuf

public abstract class AbstractDerivedByteBuf
extends AbstractByteBuf

Abstract base class for ByteBuf implementations that wrap another ByteBuf.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDerivedByteBuf(int maxCapacity)

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	internalNioBuffer(int index, int length) Internal use only: Exposes the internal NIO buffer.
ByteBuffer	nioBuffer(int index, int length) Exposes this buffer's sub-region as an NIO ByteBuffer.
int	refCnt() Returns the reference count of this object.
boolean	release() Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement) Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
ByteBuf	retain() Increases the reference count by 1.
ByteBuf	retain(int increment) Increases the reference count by the specified increment.
ByteBuf	touch() Records the current access location of this object for debugging purposes.
ByteBuf	touch(Object hint) Records the current access location of this object with an additonal arbitrary information for debugging purposes.

Methods inherited from class io.netty.buffer.AbstractByteBuf

_getByte, _getInt, _getLong, _getShort, _getUnsignedMedium, _setByte, _setInt, _setLong, _setMedium, _setShort, adjustMarkers, bytesBefore, bytesBefore, bytesBefore, checkDstIndex, checkIndex, checkIndex, checkReadableBytes, checkSrcIndex, clear, compareTo, copy, discardReadBytes, discardSomeReadBytes, duplicate, ensureAccessible, ensureWritable, ensureWritable, equals, forEachByte, forEachByte, forEachByteDesc, forEachByteDesc, getBoolean, getByte, getBytes, getBytes, getBytes, getChar, getDouble, getFloat, getInt, getLong, getMedium, getShort, getUnsignedByte, getUnsignedInt, getUnsignedMedium, getUnsignedShort, hashCode, indexOf, isReadable, isReadable, isWritable, isWritable, markReaderIndex, markWriterIndex, maxCapacity, maxCapacity, maxWritableBytes, newSwappedByteBuf, nioBuffer, nioBuffers, order, readableBytes, readBoolean, 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, setBoolean, setByte, setBytes, setBytes, setBytes, setChar, setDouble, setFloat, setIndex, setInt, setLong, setMedium, setShort, setZero, skipBytes, slice, slice, toString, toString, toString, writableBytes, writeBoolean, writeByte, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writerIndex, writerIndex, writeShort, writeZero

Methods inherited from class io.netty.buffer.ByteBuf

alloc, array, arrayOffset, capacity, capacity, copy, getBytes, getBytes, getBytes, getBytes, getBytes, hasArray, hasMemoryAddress, isDirect, memoryAddress, nioBufferCount, nioBuffers, order, setBytes, setBytes, setBytes, setBytes, setBytes, unwrap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractDerivedByteBuf

protected AbstractDerivedByteBuf(int maxCapacity)

Method Detail

refCnt

public final int refCnt()

Description copied from interface: ReferenceCounted

Returns the reference count of this object. If 0, it means this object has been deallocated.

retain

public final ByteBuf retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ReferenceCounted

Specified by:

retain in class ByteBuf

retain

public final ByteBuf retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ReferenceCounted

Specified by:

retain in class ByteBuf

touch

public final ByteBuf touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ReferenceCounted

Specified by:

touch in class ByteBuf

touch

public final ByteBuf touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additonal arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface ReferenceCounted

Specified by:

touch in class ByteBuf

release

public final boolean release()

Description copied from interface: ReferenceCounted

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Returns:

true if and only if the reference count became 0 and this object has been deallocated

release

public final boolean release(int decrement)

Description copied from interface: ReferenceCounted

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Returns:

true if and only if the reference count became 0 and this object has been deallocated

internalNioBuffer

public ByteBuffer internalNioBuffer(int index,
                           int length)

Description copied from class: ByteBuf

Internal use only: Exposes the internal NIO buffer.

Specified by:

internalNioBuffer in class ByteBuf

nioBuffer

public ByteBuffer nioBuffer(int index,
                   int length)

Description copied from class: ByteBuf

Exposes this buffer's sub-region as an NIO ByteBuffer. The returned buffer shares the content with 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.

Specified by:

nioBuffer in class ByteBuf

See Also:

ByteBuf.nioBufferCount(), ByteBuf.nioBuffers(), ByteBuf.nioBuffers(int, int)