org.apache.flink.statefun.flink.core.backpressure

Interface BackPressureValve

All Known Implementing Classes:

ThresholdBackPressureValve

public interface BackPressureValve

Method Summary

Modifier and Type	Method and Description
void	blockAddress(Address address) Requests to stop processing any further input for that address, as long as there is an uncompleted async operation (registered by @address).
boolean	isAddressBlocked(Address address) Checks whether a given address was previously blocked with blockAddress(Address).
void	notifyAsyncOperationCompleted(Address owningAddress) Notifies when a async operation, registered by @owningAddress was completed.
void	notifyAsyncOperationRegistered() Notifies the back pressure mechanism that a async operation was registered via Context.registerAsyncOperation(Object, CompletableFuture).
boolean	shouldBackPressure() Indicates rather a back pressure is needed.

Method Detail

shouldBackPressure

boolean shouldBackPressure()

Indicates rather a back pressure is needed.

Returns:

true if a back pressure should be applied.

notifyAsyncOperationRegistered

void notifyAsyncOperationRegistered()

Notifies the back pressure mechanism that a async operation was registered via Context.registerAsyncOperation(Object, CompletableFuture).

notifyAsyncOperationCompleted

void notifyAsyncOperationCompleted(Address owningAddress)

Notifies when a async operation, registered by @owningAddress was completed.

Parameters:

owningAddress - the owner of the completed async operation.

blockAddress

void blockAddress(Address address)

Requests to stop processing any further input for that address, as long as there is an uncompleted async operation (registered by @address).

NOTE: The address would unblocked as soon as some (one) async operation registered by that address completes.

Parameters:

address - the address

isAddressBlocked

boolean isAddressBlocked(Address address)

Checks whether a given address was previously blocked with blockAddress(Address).

Parameters:

address - the address to check

Returns:

boolean indicating whether or not the address was blocked.