Package org.apache.arrow.flight

Interface BackpressureStrategy

All Known Implementing Classes:

BackpressureStrategy.CallbackBackpressureStrategy

public interface BackpressureStrategy

Helper interface to dynamically handle backpressure when implementing FlightProducers. This must only be used in FlightProducer implementations that are non-blocking.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BackpressureStrategy.CallbackBackpressureStrategy	A back pressure strategy that uses callbacks to notify when the client is ready or cancelled.
static enum	BackpressureStrategy.WaitResult	The state of the client after a call to waitForListener.

Method Summary

Modifier and Type	Method	Description
void	register(FlightProducer.ServerStreamListener listener)	Set up operations to work against the given listener.
BackpressureStrategy.WaitResult	waitForListener(long timeout)	Waits for the listener to be ready or cancelled up to the given timeout.

Method Details

register

void register(FlightProducer.ServerStreamListener listener)

Set up operations to work against the given listener.

This must be called exactly once and before any calls to waitForListener(long) and OutboundStreamListener.start(VectorSchemaRoot)

Parameters:

listener - The listener this strategy applies to.

waitForListener

BackpressureStrategy.WaitResult waitForListener(long timeout)

Waits for the listener to be ready or cancelled up to the given timeout.

Parameters:

timeout - The timeout in milliseconds. Infinite if timeout is <= 0.

Returns:

The result of the wait.