Class UnreleasableByteBuf

java.lang.Object

io.netty.buffer.ByteBuf

io.netty.buffer.WrappedByteBuf

io.netty.buffer.UnreleasableByteBuf

All Implemented Interfaces:

ByteBufConvertible, ReferenceCounted, Comparable<ByteBuf>

final class UnreleasableByteBuf
extends WrappedByteBuf

A ByteBuf implementation that wraps another buffer to prevent a user from increasing or decreasing the wrapped buffer's reference count.

Field Summary

Fields

Modifier and Type	Field	Description
private SwappedByteBuf	swappedBuf

Fields inherited from class WrappedByteBuf

buf

Constructor Summary

Constructors

Constructor	Description
UnreleasableByteBuf(ByteBuf buf)

Method Summary

Modifier and Type	Method	Description
ByteBuf	asReadOnly()	Returns a read-only version of this buffer.
ByteBuf	duplicate()	Returns a buffer which shares the whole region of this buffer.
ByteBuf	order(ByteOrder endianness)	Returns a buffer with the specified endianness which shares the whole region, indexes, and marks of this buffer.
ByteBuf	readRetainedSlice(int length)	Returns a new retained slice of this buffer's sub-region starting at the current readerIndex and increases the readerIndex by the size of the new slice (= length).
ByteBuf	readSlice(int length)	Returns a new slice of this buffer's sub-region starting at the current readerIndex and increases the readerIndex by the size of the new slice (= length).
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	retainedDuplicate()	Returns a retained buffer which shares the whole region of this buffer.
ByteBuf	retainedSlice()	Returns a retained slice of this buffer's readable bytes.
ByteBuf	retainedSlice(int index, int length)	Returns a retained slice of this buffer's sub-region.
ByteBuf	slice()	Returns a slice of this buffer's readable bytes.
ByteBuf	slice(int index, int length)	Returns a slice of this buffer's sub-region.
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 additional arbitrary information for debugging purposes.

Methods inherited from class WrappedByteBuf

alloc, array, arrayOffset, bytesBefore, bytesBefore, bytesBefore, capacity, capacity, clear, compareTo, copy, copy, discardReadBytes, discardSomeReadBytes, ensureWritable, ensureWritable, equals, forEachByte, forEachByte, forEachByteDesc, forEachByteDesc, getBoolean, getByte, getBytes, getBytes, getBytes, getBytes, getBytes, getBytes, getBytes, getBytes, getBytes, getChar, getCharSequence, getDouble, getFloat, getInt, getIntLE, getLong, getLongLE, getMedium, getMediumLE, getShort, getShortLE, getUnsignedByte, getUnsignedInt, getUnsignedIntLE, getUnsignedMedium, getUnsignedMediumLE, getUnsignedShort, getUnsignedShortLE, hasArray, hashCode, hasMemoryAddress, indexOf, internalNioBuffer, isAccessible, isContiguous, isDirect, isReadable, isReadable, isReadOnly, isWritable, isWritable, markReaderIndex, markWriterIndex, maxCapacity, maxFastWritableBytes, maxWritableBytes, memoryAddress, nioBuffer, nioBuffer, nioBufferCount, nioBuffers, nioBuffers, order, readableBytes, readBoolean, readByte, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readChar, readCharSequence, readDouble, readerIndex, readerIndex, readFloat, readInt, readIntLE, readLong, readLongLE, readMedium, readMediumLE, readShort, readShortLE, readUnsignedByte, readUnsignedInt, readUnsignedIntLE, readUnsignedMedium, readUnsignedMediumLE, readUnsignedShort, readUnsignedShortLE, refCnt, resetReaderIndex, resetWriterIndex, setBoolean, setByte, setBytes, setBytes, setBytes, setBytes, setBytes, setBytes, setBytes, setBytes, setBytes, setChar, setCharSequence, setDouble, setFloat, setIndex, setInt, setIntLE, setLong, setLongLE, setMedium, setMediumLE, setShort, setShortLE, setZero, skipBytes, toString, toString, toString, unwrap, writableBytes, writeBoolean, writeByte, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeChar, writeCharSequence, writeDouble, writeFloat, writeInt, writeIntLE, writeLong, writeLongLE, writeMedium, writeMediumLE, writerIndex, writerIndex, writeShort, writeShortLE, writeZero

Methods inherited from class ByteBuf

asByteBuf, getDoubleLE, getFloatLE, readDoubleLE, readFloatLE, setDoubleLE, setFloatLE, writeDoubleLE, writeFloatLE

Methods inherited from class Object

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

Field Details

swappedBuf

private SwappedByteBuf swappedBuf

Constructor Details

UnreleasableByteBuf

UnreleasableByteBuf(ByteBuf buf)

Method Details

order

public ByteBuf order(ByteOrder endianness)

Description copied from class: ByteBuf

Returns a buffer with the specified endianness which shares the whole region, indexes, and marks of this buffer. Modifying the content, the indexes, or the marks of the returned buffer or this buffer affects each other's content, indexes, and marks. If the specified endianness is identical to this buffer's byte order, this method can return this. This method does not modify readerIndex or writerIndex of this buffer.

Overrides:

order in class WrappedByteBuf

asReadOnly

public ByteBuf asReadOnly()

Description copied from class: ByteBuf

Returns a read-only version of this buffer.

Overrides:

asReadOnly in class WrappedByteBuf

readSlice

public ByteBuf readSlice(int length)

Description copied from class: ByteBuf

Returns a new slice of this buffer's sub-region starting at the current readerIndex and increases the readerIndex by the size of the new slice (= length).

Also be aware that this method will NOT call ByteBuf.retain() and so the reference count will NOT be increased.

Overrides:

readSlice in class WrappedByteBuf

Parameters:

length - the size of the new slice

Returns:

the newly created slice

readRetainedSlice

public ByteBuf readRetainedSlice(int length)

Description copied from class: ByteBuf

Returns a new retained slice of this buffer's sub-region starting at the current readerIndex and increases the readerIndex by the size of the new slice (= length).

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

Overrides:

readRetainedSlice in class WrappedByteBuf

Parameters:

length - the size of the new slice

Returns:

the newly created slice

slice

public ByteBuf slice()

Description copied from class: ByteBuf

Returns a 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.

Also be aware that this method will NOT call ByteBuf.retain() and so the reference count will NOT be increased.

Overrides:

slice in class WrappedByteBuf

retainedSlice

public ByteBuf retainedSlice()

Description copied from class: ByteBuf

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 ByteBuf.slice(). This method behaves similarly to slice().retain() except that this method may return a buffer implementation that produces less garbage.

Overrides:

retainedSlice in class WrappedByteBuf

slice

public ByteBuf slice(int index,
 int length)

Description copied from class: ByteBuf

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

Also be aware that this method will NOT call ByteBuf.retain() and so the reference count will NOT be increased.

Overrides:

slice in class WrappedByteBuf

retainedSlice

public ByteBuf retainedSlice(int index,
 int length)

Description copied from class: ByteBuf

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 ByteBuf.slice(int, int). This method behaves similarly to slice(...).retain() except that this method may return a buffer implementation that produces less garbage.

Overrides:

retainedSlice in class WrappedByteBuf

duplicate

public ByteBuf duplicate()

Description copied from class: ByteBuf

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 does not modify readerIndex or writerIndex of this buffer.

The reader and writer marks will not be duplicated. Also be aware that this method will NOT call ByteBuf.retain() and so the reference count will NOT be increased.

Overrides:

duplicate in class WrappedByteBuf

Returns:

A buffer whose readable content is equivalent to the buffer returned by ByteBuf.slice(). However this buffer will share the capacity of the underlying buffer, and therefore allows access to all of the underlying content if necessary.

retainedDuplicate

public ByteBuf retainedDuplicate()

Description copied from class: ByteBuf

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 ByteBuf.slice(int, int). This method behaves similarly to duplicate().retain() except that this method may return a buffer implementation that produces less garbage.

Overrides:

retainedDuplicate in class WrappedByteBuf

retain

public ByteBuf retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class WrappedByteBuf

retain

public ByteBuf retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class WrappedByteBuf

touch

public 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

Overrides:

touch in class WrappedByteBuf

touch

public ByteBuf touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional 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

Overrides:

touch in class WrappedByteBuf

release

public boolean release()

Description copied from interface: ReferenceCounted

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

Specified by:

release in interface ReferenceCounted

Overrides:

release in class WrappedByteBuf

Returns:

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

release

public 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.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class WrappedByteBuf

Returns:

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