HsBufferContext (Flink : Runtime 1.18.1-cp1 API)

java.lang.Object
- org.apache.flink.runtime.io.network.partition.hybrid.HsBufferContext

```
public class HsBufferContext
extends Object
```
This class maintains the buffer's reference count and its status for hybrid shuffle mode.
Each buffer has three status: released, spillStarted, consumed.
- released indicates that buffer has been released from the memory data manager, and can no longer be spilled or consumed.
- spillStarted indicates that spilling of the buffer has started, either completed or not.
- consumed indicates that buffer has been consumed by these consumers.
Reference count of the buffer is maintained as follows: *
- +1 when the buffer is obtained by memory data manager (from the buffer pool), and -1 when it is released from memory data manager.
- +1 when spilling of the buffer is tarted, and -1 when it is completed.
- +1 when the buffer is being consumed, and -1 when consuming is completed (by the downstream).
Note: This class is not thread-safe.

Constructor Summary

Constructors
Constructor Description

HsBufferContext(Buffer buffer, int bufferIndex, int subpartitionId)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`consumed(HsConsumerId consumerId)`
`Buffer`	`getBuffer()`
`BufferIndexAndChannel`	`getBufferIndexAndChannel()`
`Optional<CompletableFuture<Void>>`	`getSpilledFuture()`
`boolean`	`isConsumed(HsConsumerId consumerId)`
`boolean`	`isReleased()`
`boolean`	`isSpillStarted()`
`void`	`release()`	Mark buffer status to release.
`boolean`	`startSpilling(CompletableFuture<Void> spilledFuture)`	Mark buffer status to startSpilling.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HsBufferContext

public HsBufferContext(Buffer buffer,
                       int bufferIndex,
                       int subpartitionId)

Method Detail

getBuffer
```
public Buffer getBuffer()
```

getBufferIndexAndChannel

public BufferIndexAndChannel getBufferIndexAndChannel()

isReleased
```
public boolean isReleased()
```

isSpillStarted
```
public boolean isSpillStarted()
```

isConsumed

public boolean isConsumed(HsConsumerId consumerId)

getSpilledFuture

public Optional<CompletableFuture<Void>> getSpilledFuture()

release
```
public void release()
```
Mark buffer status to release.

startSpilling
```
public boolean startSpilling(CompletableFuture<Void> spilledFuture)
```
Mark buffer status to startSpilling.

Parameters:

spilledFuture - completable future of this buffer's spilling operation.

Returns:

false, if spilling of the buffer has been started before or the buffer has been released already; true, otherwise.

consumed

public void consumed(HsConsumerId consumerId)