CompositeBuffer (Flink : Runtime 1.16.0 API)

java.lang.Object
- org.apache.flink.runtime.io.network.buffer.CompositeBuffer

所有已实现的接口:

Buffer
```
public class CompositeBuffer
extends Object
implements Buffer
```
An implementation of Buffer which contains multiple partial buffers for network data communication.

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

构造器概要

构造器
构造器和说明

CompositeBuffer(Buffer.DataType dataType, int length, boolean isCompressed)

CompositeBuffer(BufferHeader header)

构造器
构造器和说明
`CompositeBuffer(Buffer.DataType dataType, int length, boolean isCompressed)`
`CompositeBuffer(BufferHeader header)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addPartialBuffer(Buffer buffer)`
`org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf`	`asByteBuf()`
`Buffer.DataType`	`getDataType()` Gets the type of data this buffer represents.
`Buffer`	`getFullBufferData(org.apache.flink.core.memory.MemorySegment segment)` Returns the full buffer data in one piece of `MemorySegment`.
`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.
`int`	`missingLength()`
`int`	`numPartialBuffers()`
`int`	`readableBytes()` Returns the number of readable bytes (same as `Buffer.getSize() - Buffer.getReaderIndex()`).
`Buffer`	`readOnlySlice()` Returns a read-only slice of this buffer's readable bytes, i.e. between `Buffer.getReaderIndex()` and `Buffer.getSize()`.
`Buffer`	`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`.
`int`	`refCnt()` The current reference counter.
`Buffer`	`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.

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

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

- 构造器详细资料
  - CompositeBuffer
```
public CompositeBuffer(Buffer.DataType dataType,
                       int length,
                       boolean isCompressed)
```
  - CompositeBuffer
```
public CompositeBuffer(BufferHeader header)
```
- 方法详细资料
  - 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
  - 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()
  - retainBuffer
```
public Buffer retainBuffer()
```
    从接口复制的说明: Buffer
    
    Retains this buffer for further use, increasing the reference counter by 1.
    
    指定者:
    
    retainBuffer 在接口中 Buffer
    
    返回:
    
    this instance (for chained calls)
    
    另请参阅:
    
    Buffer.recycleBuffer()
  - 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))
  - readableBytes
```
public int readableBytes()
```
    从接口复制的说明: Buffer
    
    Returns the number of readable bytes (same as Buffer.getSize() - Buffer.getReaderIndex()).
    
    指定者:
    
    readableBytes 在接口中 Buffer
  - 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
    
    返回:
    
    self as ByteBuf implementation.
  - isCompressed
```
public boolean isCompressed()
```
    指定者:
    
    isCompressed 在接口中 Buffer
    
    返回:
    
    whether the buffer is compressed or not.
  - getDataType
```
public Buffer.DataType getDataType()
```
    从接口复制的说明: Buffer
    
    Gets the type of data this buffer represents.
    
    指定者:
    
    getDataType 在接口中 Buffer
  - numPartialBuffers
```
public int numPartialBuffers()
```
  - getFullBufferData
```
public Buffer getFullBufferData(org.apache.flink.core.memory.MemorySegment segment)
```
    Returns the full buffer data in one piece of MemorySegment. If there is multiple partial buffers, the partial data will be copied to the given target MemorySegment.
  - addPartialBuffer
```
public void addPartialBuffer(Buffer buffer)
```
  - missingLength
```
public int missingLength()
```
  - getMemorySegment
```
public org.apache.flink.core.memory.MemorySegment getMemorySegment()
```
    从接口复制的说明: Buffer
    
    Returns the underlying memory segment. This method is dangerous since it ignores read only protections and omits slices. Use it only along the Buffer.getMemorySegmentOffset().
    This method will be removed in the future. For writing use BufferBuilder.
    
    指定者:
    
    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
  - isRecycled
```
public boolean isRecycled()
```
    从接口复制的说明: Buffer
    
    Returns whether this buffer has been recycled or not.
    
    指定者:
    
    isRecycled 在接口中 Buffer
    
    返回:
    
    true if already recycled, false otherwise
  - readOnlySlice
```
public Buffer 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 Buffer 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)
```
    从接口复制的说明: Buffer
    
    Sets the reader index of this buffer.
    
    指定者:
    
    setReaderIndex 在接口中 Buffer
  - 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)
```
    从接口复制的说明: 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
    
    另请参阅:
    
    Buffer.getNioBufferReadable()
  - setCompressed
```
public void setCompressed(boolean isCompressed)
```
    从接口复制的说明: Buffer
    
    Tags the buffer as compressed or uncompressed.
    
    指定者:
    
    setCompressed 在接口中 Buffer
  - setDataType
```
public void setDataType(Buffer.DataType dataType)
```
    从接口复制的说明: Buffer
    
    Sets the type of data this buffer represents.
    
    指定者:
    
    setDataType 在接口中 Buffer
  - refCnt
```
public int refCnt()
```
    从接口复制的说明: Buffer
    
    The current reference counter. Increased by Buffer.retainBuffer() and decreased with Buffer.recycleBuffer().
    
    指定者:
    
    refCnt 在接口中 Buffer

类 CompositeBuffer

嵌套类概要

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

构造器概要

方法概要

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

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

构造器详细资料

CompositeBuffer

CompositeBuffer

方法详细资料

isBuffer

recycleBuffer

retainBuffer

getSize

readableBytes

setAllocator

asByteBuf

isCompressed

getDataType

numPartialBuffers

getFullBufferData

addPartialBuffer

missingLength

getMemorySegment

getMemorySegmentOffset

getRecycler

isRecycled

readOnlySlice

readOnlySlice

getMaxCapacity

getReaderIndex

setReaderIndex

setSize

getNioBufferReadable

getNioBuffer

setCompressed

setDataType

refCnt