Package io.netty.buffer

Class ReadOnlyByteBufferBuf.ReadOnlySlicedByteBuf

java.lang.Object

io.netty.buffer.ByteBuf

io.netty.buffer.AbstractByteBuf

io.netty.buffer.AbstractDerivedByteBuf

io.netty.buffer.AbstractUnpooledSlicedByteBuf

io.netty.buffer.SlicedByteBuf

io.netty.buffer.ReadOnlyByteBufferBuf.ReadOnlySlicedByteBuf

All Implemented Interfaces:

ByteBufConvertible, ReferenceCounted, Comparable<ByteBuf>

Enclosing class:

ReadOnlyByteBufferBuf

private static final class ReadOnlyByteBufferBuf.ReadOnlySlicedByteBuf
extends SlicedByteBuf

Field Summary

Fields inherited from class io.netty.buffer.AbstractByteBuf

checkAccessible, leakDetector, readerIndex, writerIndex

Constructor Summary

Constructors

Constructor	Description
ReadOnlySlicedByteBuf(ByteBuf buffer, int index, int length)

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.
int	ensureWritable(int minWritableBytes, boolean force)	Expands the buffer ByteBuf.capacity() to make sure the number of writable bytes is equal to or greater than the specified value.
boolean	isWritable()	Returns true if and only if (this.capacity - this.writerIndex) is greater than 0.
boolean	isWritable(int numBytes)	Returns true if and only if this buffer has enough room to allow writing the specified number of elements.
ByteBuf	slice(int index, int length)	Returns a slice of this buffer's sub-region.

Methods inherited from class io.netty.buffer.SlicedByteBuf

capacity, initLength, length

Methods inherited from class io.netty.buffer.AbstractUnpooledSlicedByteBuf

_getByte, _getInt, _getIntLE, _getLong, _getLongLE, _getShort, _getShortLE, _getUnsignedMedium, _getUnsignedMediumLE, _setByte, _setInt, _setIntLE, _setLong, _setLongLE, _setMedium, _setMediumLE, _setShort, _setShortLE, alloc, array, arrayOffset, capacity, checkSliceOutOfBounds, copy, forEachByte, forEachByteDesc, getByte, getBytes, getBytes, getBytes, getBytes, getBytes, getBytes, getCharSequence, getInt, getIntLE, getLong, getLongLE, getShort, getShortLE, getUnsignedMedium, getUnsignedMediumLE, hasArray, hasMemoryAddress, idx, isDirect, memoryAddress, nioBuffer, nioBufferCount, nioBuffers, order, retainedDuplicate, setByte, setBytes, setBytes, setBytes, setBytes, setBytes, setBytes, setInt, setIntLE, setLong, setLongLE, setMedium, setMediumLE, setShort, setShortLE, unwrap

Methods inherited from class io.netty.buffer.AbstractDerivedByteBuf

internalNioBuffer, isAccessible, isAccessible0, isContiguous, isReadOnly, refCnt, refCnt0, release, release, release0, release0, retain, retain, retain0, retain0, touch, touch, touch0, touch0

Methods inherited from class io.netty.buffer.AbstractByteBuf

adjustMarkers, bytesBefore, bytesBefore, bytesBefore, checkDstIndex, checkDstIndex, checkIndex, checkIndex, checkIndex0, checkNewCapacity, checkReadableBytes, checkSrcIndex, clear, compareTo, copy, discardMarks, discardReadBytes, discardSomeReadBytes, ensureAccessible, ensureWritable, ensureWritable0, equals, forEachByte, forEachByteAsc0, forEachByteDesc, forEachByteDesc0, getBoolean, getBytes, getBytes, getBytes, getChar, getDouble, getFloat, getMedium, getMediumLE, getUnsignedByte, getUnsignedInt, getUnsignedIntLE, getUnsignedShort, getUnsignedShortLE, hashCode, indexOf, isReadable, isReadable, markReaderIndex, markWriterIndex, maxCapacity, maxCapacity, maxWritableBytes, newSwappedByteBuf, nioBuffer, 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, readRetainedSlice, readShort, readShortLE, readSlice, readUnsignedByte, readUnsignedInt, readUnsignedIntLE, readUnsignedMedium, readUnsignedMediumLE, readUnsignedShort, readUnsignedShortLE, resetReaderIndex, resetWriterIndex, retainedSlice, retainedSlice, setBoolean, setBytes, setBytes, setBytes, setChar, setCharSequence, setDouble, setFloat, setIndex, setIndex0, setZero, skipBytes, slice, toString, toString, toString, trimIndicesToCapacity, 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 io.netty.buffer.ByteBuf

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

Methods inherited from class java.lang.Object

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

Constructor Details

ReadOnlySlicedByteBuf

ReadOnlySlicedByteBuf(ByteBuf buffer,
 int index,
 int length)

Method Details

asReadOnly

public ByteBuf asReadOnly()

Description copied from class: ByteBuf

Returns a read-only version of this buffer.

Overrides:

asReadOnly in class AbstractByteBuf

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 AbstractUnpooledSlicedByteBuf

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 AbstractUnpooledSlicedByteBuf

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.

isWritable

public boolean isWritable()

Description copied from class: ByteBuf

Returns true if and only if (this.capacity - this.writerIndex) is greater than 0.

Overrides:

isWritable in class AbstractByteBuf

isWritable

public boolean isWritable(int numBytes)

Description copied from class: ByteBuf

Returns true if and only if this buffer has enough room to allow writing the specified number of elements.

Overrides:

isWritable in class AbstractByteBuf

ensureWritable

public int ensureWritable(int minWritableBytes,
 boolean force)

Description copied from class: ByteBuf

Expands the buffer ByteBuf.capacity() to make sure the number of writable bytes is equal to or greater than the specified value. Unlike ByteBuf.ensureWritable(int), this method returns a status code.

Overrides:

ensureWritable in class AbstractByteBuf

Parameters:

minWritableBytes - the expected minimum number of writable bytes

force - When ByteBuf.writerIndex() + minWritableBytes > ByteBuf.maxCapacity():

• true - the capacity of the buffer is expanded to ByteBuf.maxCapacity()
• false - the capacity of the buffer is unchanged

Returns:

0 if the buffer has enough writable bytes, and its capacity is unchanged. 1 if the buffer does not have enough bytes, and its capacity is unchanged. 2 if the buffer has enough writable bytes, and its capacity has been increased. 3 if the buffer does not have enough bytes, but its capacity has been increased to its maximum.