ReadOnlySlicedNetworkBuffer (Flink : Runtime 1.17.1 API)

java.lang.Object
- org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf
- - org.apache.flink.shaded.netty4.io.netty.buffer.AbstractByteBuf
  - - org.apache.flink.shaded.netty4.io.netty.buffer.AbstractDerivedByteBuf
    - - org.apache.flink.shaded.netty4.io.netty.buffer.ReadOnlyByteBuf
      - org.apache.flink.runtime.io.network.buffer.ReadOnlySlicedNetworkBuffer

所有已实现的接口:

Comparable<org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf>, Buffer, org.apache.flink.shaded.netty4.io.netty.buffer.ByteBufConvertible, org.apache.flink.shaded.netty4.io.netty.util.ReferenceCounted
```
public final class ReadOnlySlicedNetworkBuffer
extends org.apache.flink.shaded.netty4.io.netty.buffer.ReadOnlyByteBuf
implements Buffer
```
Minimal best-effort read-only sliced Buffer implementation wrapping a NetworkBuffer's sub-region based on io.netty.buffer.SlicedByteBuf and io.netty.buffer.ReadOnlyByteBuf.
BEWARE: We do not guarantee to block every operation that is able to write data but all returned data structures should be handled as if it was!.

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.flink.runtime.io.network.buffer.Buffer
  Buffer.DataType

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf`	`asByteBuf()`
`org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf`	`ensureWritable(int minWritableBytes)`
`Buffer.DataType`	`getDataType()` Gets the type of data this buffer represents.
`int`	`getMaxCapacity()` Returns the maximum size of the buffer, i.e. the capacity of the underlying `MemorySegment`.
`org.apache.flink.core.memory.MemorySegment`	`getMemorySegment()` Returns the underlying memory segment.
`int`	`getMemorySegmentOffset()` This method will be removed in the future.
`ByteBuffer`	`getNioBuffer(int index, int length)` Gets a new `ByteBuffer` instance wrapping this buffer's bytes.
`ByteBuffer`	`getNioBufferReadable()` Gets a new `ByteBuffer` instance wrapping this buffer's readable bytes, i.e. between `Buffer.getReaderIndex()` and `Buffer.getSize()`.
`int`	`getReaderIndex()` Returns the `reader index` of this buffer.
`BufferRecycler`	`getRecycler()` Gets the buffer's recycler.
`int`	`getSize()` Returns the size of the written data, i.e. the `writer index`, of this buffer.
`boolean`	`isBuffer()` Returns whether this buffer represents a buffer or an event.
`boolean`	`isCompressed()`
`boolean`	`isRecycled()` Returns whether this buffer has been recycled or not.
`boolean`	`isWritable()`
`boolean`	`isWritable(int numBytes)`
`ByteBuffer`	`nioBuffer(int index, int length)`
`ReadOnlySlicedNetworkBuffer`	`readOnlySlice()` Returns a read-only slice of this buffer's readable bytes, i.e. between `Buffer.getReaderIndex()` and `Buffer.getSize()`.
`ReadOnlySlicedNetworkBuffer`	`readOnlySlice(int index, int length)` Returns a read-only slice of this buffer.
`void`	`recycleBuffer()` Releases this buffer once, i.e. reduces the reference count and recycles the buffer if the reference count reaches `0`.
`ReadOnlySlicedNetworkBuffer`	`retainBuffer()` Retains this buffer for further use, increasing the reference counter by `1`.
`void`	`setAllocator(org.apache.flink.shaded.netty4.io.netty.buffer.ByteBufAllocator allocator)` Sets the buffer allocator for use in netty.
`void`	`setCompressed(boolean isCompressed)` Tags the buffer as compressed or uncompressed.
`void`	`setDataType(Buffer.DataType dataType)` Sets the type of data this buffer represents.
`void`	`setReaderIndex(int readerIndex)` Sets the `reader index` of this buffer.
`void`	`setSize(int writerIndex)` Sets the size of the written data, i.e. the `writer index`, of this buffer.
`org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf`	`unwrap()`

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.buffer.ReadOnlyByteBuf
_getByte, _getInt, _getIntLE, _getLong, _getLongLE, _getShort, _getShortLE, _getUnsignedMedium, _getUnsignedMediumLE, _setByte, _setInt, _setIntLE, _setLong, _setLongLE, _setMedium, _setMediumLE, _setShort, _setShortLE, alloc, array, arrayOffset, asReadOnly, capacity, capacity, copy, discardReadBytes, duplicate, ensureWritable, forEachByte, forEachByteDesc, getByte, getBytes, getBytes, getBytes, getBytes, getBytes, getBytes, getInt, getIntLE, getLong, getLongLE, getShort, getShortLE, getUnsignedMedium, getUnsignedMediumLE, hasArray, hasMemoryAddress, isDirect, isReadOnly, memoryAddress, nioBufferCount, nioBuffers, order, setByte, setBytes, setBytes, setBytes, setBytes, setBytes, setBytes, setInt, setIntLE, setLong, setLongLE, setMedium, setMediumLE, setShort, setShortLE, slice

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.buffer.AbstractDerivedByteBuf
internalNioBuffer, isContiguous, refCnt, release, release, retain, retain, touch, touch

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.buffer.AbstractByteBuf
adjustMarkers, bytesBefore, bytesBefore, bytesBefore, checkDstIndex, checkDstIndex, checkIndex, checkIndex, checkNewCapacity, checkReadableBytes, checkSrcIndex, clear, compareTo, copy, discardSomeReadBytes, ensureAccessible, equals, forEachByte, forEachByteDesc, getBoolean, getBytes, getBytes, getBytes, getChar, getCharSequence, 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, retainedDuplicate, retainedSlice, retainedSlice, setBoolean, setBytes, setBytes, setBytes, setChar, setCharSequence, setDouble, setFloat, setIndex, 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

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf
getDoubleLE, getFloatLE, maxFastWritableBytes, readDoubleLE, readFloatLE, setDoubleLE, setFloatLE, writeDoubleLE, writeFloatLE

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.flink.runtime.io.network.buffer.Buffer
readableBytes, refCnt, toDebugString

- 方法详细资料
  - unwrap
```
public org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf unwrap()
```
    覆盖:
    
    unwrap 在类中 org.apache.flink.shaded.netty4.io.netty.buffer.ReadOnlyByteBuf
  - isBuffer
```
public boolean isBuffer()
```
    从接口复制的说明: Buffer
    
    Returns whether this buffer represents a buffer or an event.
    
    指定者:
    
    isBuffer 在接口中 Buffer
    
    返回:
    
    true if this is a real buffer, false if this is an event
  - getMemorySegment
```
public org.apache.flink.core.memory.MemorySegment getMemorySegment()
```
    Returns the underlying memory segment.
    BEWARE: Although we cannot set the memory segment read-only it should be handled as if it was!.
    
    指定者:
    
    getMemorySegment 在接口中 Buffer
    
    返回:
    
    the memory segment backing this buffer
  - getMemorySegmentOffset
```
public int getMemorySegmentOffset()
```
    从接口复制的说明: Buffer
    
    This method will be removed in the future. For writing use BufferBuilder.
    
    指定者:
    
    getMemorySegmentOffset 在接口中 Buffer
    
    返回:
    
    the offset where this (potential slice) Buffer's data start in the underlying memory segment.
  - getRecycler
```
public BufferRecycler getRecycler()
```
    从接口复制的说明: Buffer
    
    Gets the buffer's recycler.
    
    指定者:
    
    getRecycler 在接口中 Buffer
    
    返回:
    
    buffer recycler
  - recycleBuffer
```
public void recycleBuffer()
```
    从接口复制的说明: Buffer
    
    Releases this buffer once, i.e. reduces the reference count and recycles the buffer if the reference count reaches 0.
    
    指定者:
    
    recycleBuffer 在接口中 Buffer
    
    另请参阅:
    
    Buffer.retainBuffer()
  - isRecycled
```
public boolean isRecycled()
```
    从接口复制的说明: Buffer
    
    Returns whether this buffer has been recycled or not.
    
    指定者:
    
    isRecycled 在接口中 Buffer
    
    返回:
    
    true if already recycled, false otherwise
  - retainBuffer
```
public ReadOnlySlicedNetworkBuffer retainBuffer()
```
    从接口复制的说明: Buffer
    
    Retains this buffer for further use, increasing the reference counter by 1.
    
    指定者:
    
    retainBuffer 在接口中 Buffer
    
    返回:
    
    this instance (for chained calls)
    
    另请参阅:
    
    Buffer.recycleBuffer()
  - readOnlySlice
```
public ReadOnlySlicedNetworkBuffer readOnlySlice()
```
    从接口复制的说明: Buffer
    
    Returns a read-only slice of this buffer's readable bytes, i.e. between Buffer.getReaderIndex() and Buffer.getSize().
    Reader and writer indices as well as markers are not shared. Reference counters are shared but the slice is not retained automatically.
    
    指定者:
    
    readOnlySlice 在接口中 Buffer
    
    返回:
    
    a read-only sliced buffer
  - readOnlySlice
```
public ReadOnlySlicedNetworkBuffer readOnlySlice(int index,
                                                 int length)
```
    从接口复制的说明: Buffer
    
    Returns a read-only slice of this buffer.
    Reader and writer indices as well as markers are not shared. Reference counters are shared but the slice is not retained automatically.
    
    指定者:
    
    readOnlySlice 在接口中 Buffer
    
    参数:
    
    index - the index to start from
    
    length - the length of the slice
    
    返回:
    
    a read-only sliced buffer
  - getMaxCapacity
```
public int getMaxCapacity()
```
    从接口复制的说明: Buffer
    
    Returns the maximum size of the buffer, i.e. the capacity of the underlying MemorySegment.
    
    指定者:
    
    getMaxCapacity 在接口中 Buffer
    
    返回:
    
    size of the buffer
  - getReaderIndex
```
public int getReaderIndex()
```
    从接口复制的说明: Buffer
    
    Returns the reader index of this buffer.
    This is where readable (unconsumed) bytes start in the backing memory segment.
    
    指定者:
    
    getReaderIndex 在接口中 Buffer
    
    返回:
    
    reader index (from 0 (inclusive) to the size of the backing MemorySegment (inclusive))
  - setReaderIndex
```
public void setReaderIndex(int readerIndex)
                    throws IndexOutOfBoundsException
```
    从接口复制的说明: Buffer
    
    Sets the reader index of this buffer.
    
    指定者:
    
    setReaderIndex 在接口中 Buffer
    
    抛出:
    
    IndexOutOfBoundsException - if the index is less than 0 or greater than Buffer.getSize()
  - getSize
```
public int getSize()
```
    从接口复制的说明: Buffer
    
    Returns the size of the written data, i.e. the writer index, of this buffer.
    This is where writable bytes start in the backing memory segment.
    
    指定者:
    
    getSize 在接口中 Buffer
    
    返回:
    
    writer index (from 0 (inclusive) to the size of the backing MemorySegment (inclusive))
  - setSize
```
public void setSize(int writerIndex)
```
    从接口复制的说明: Buffer
    
    Sets the size of the written data, i.e. the writer index, of this buffer.
    
    指定者:
    
    setSize 在接口中 Buffer
  - getNioBufferReadable
```
public ByteBuffer getNioBufferReadable()
```
    从接口复制的说明: Buffer
    
    Gets a new ByteBuffer instance wrapping this buffer's readable bytes, i.e. between Buffer.getReaderIndex() and Buffer.getSize().
    Please note that neither index is updated by the returned buffer.
    
    指定者:
    
    getNioBufferReadable 在接口中 Buffer
    
    返回:
    
    byte buffer sharing the contents of the underlying memory segment
  - getNioBuffer
```
public ByteBuffer getNioBuffer(int index,
                               int length)
                        throws IndexOutOfBoundsException
```
    从接口复制的说明: Buffer
    
    Gets a new ByteBuffer instance wrapping this buffer's bytes.
    Please note that neither read nor write index are updated by the returned buffer.
    
    指定者:
    
    getNioBuffer 在接口中 Buffer
    
    返回:
    
    byte buffer sharing the contents of the underlying memory segment
    
    抛出:
    
    IndexOutOfBoundsException - if the indexes are not without the buffer's bounds
    
    另请参阅:
    
    Buffer.getNioBufferReadable()
  - nioBuffer
```
public ByteBuffer nioBuffer(int index,
                            int length)
```
    覆盖:
    
    nioBuffer 在类中 org.apache.flink.shaded.netty4.io.netty.buffer.ReadOnlyByteBuf
  - isWritable
```
public boolean isWritable()
```
    覆盖:
    
    isWritable 在类中 org.apache.flink.shaded.netty4.io.netty.buffer.ReadOnlyByteBuf
  - isWritable
```
public boolean isWritable(int numBytes)
```
    覆盖:
    
    isWritable 在类中 org.apache.flink.shaded.netty4.io.netty.buffer.ReadOnlyByteBuf
  - ensureWritable
```
public org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf ensureWritable(int minWritableBytes)
```
    覆盖:
    
    ensureWritable 在类中 org.apache.flink.shaded.netty4.io.netty.buffer.ReadOnlyByteBuf
  - setAllocator
```
public void setAllocator(org.apache.flink.shaded.netty4.io.netty.buffer.ByteBufAllocator allocator)
```
    从接口复制的说明: Buffer
    
    Sets the buffer allocator for use in netty.
    
    指定者:
    
    setAllocator 在接口中 Buffer
    
    参数:
    
    allocator - netty buffer allocator
  - asByteBuf
```
public org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf asByteBuf()
```
    指定者:
    
    asByteBuf 在接口中 Buffer
    
    指定者:
    
    asByteBuf 在接口中 org.apache.flink.shaded.netty4.io.netty.buffer.ByteBufConvertible
    
    覆盖:
    
    asByteBuf 在类中 org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf
    
    返回:
    
    self as ByteBuf implementation.
  - isCompressed
```
public boolean isCompressed()
```
    指定者:
    
    isCompressed 在接口中 Buffer
    
    返回:
    
    whether the buffer is compressed or not.
  - setCompressed
```
public void setCompressed(boolean isCompressed)
```
    从接口复制的说明: Buffer
    
    Tags the buffer as compressed or uncompressed.
    
    指定者:
    
    setCompressed 在接口中 Buffer
  - getDataType
```
public Buffer.DataType getDataType()
```
    从接口复制的说明: Buffer
    
    Gets the type of data this buffer represents.
    
    指定者:
    
    getDataType 在接口中 Buffer
  - setDataType
```
public void setDataType(Buffer.DataType dataType)
```
    从接口复制的说明: Buffer
    
    Sets the type of data this buffer represents.
    
    指定者:
    
    setDataType 在接口中 Buffer

类 ReadOnlySlicedNetworkBuffer

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.runtime.io.network.buffer.Buffer

方法概要

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.buffer.ReadOnlyByteBuf

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.buffer.AbstractDerivedByteBuf

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.buffer.AbstractByteBuf

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.flink.runtime.io.network.buffer.Buffer

方法详细资料

unwrap

isBuffer

getMemorySegment

getMemorySegmentOffset

getRecycler

recycleBuffer

isRecycled

retainBuffer

readOnlySlice

readOnlySlice

getMaxCapacity

getReaderIndex

setReaderIndex

getSize

setSize

getNioBufferReadable

getNioBuffer

nioBuffer

isWritable

isWritable

ensureWritable

setAllocator

asByteBuf

isCompressed

setCompressed

getDataType

setDataType