org.apache.beam.sdk.fn.data

Interface InboundDataClient

All Known Implementing Classes:

BeamFnDataInboundObserver, CompletableFutureInboundDataClient

public interface InboundDataClient

A client representing some stream of inbound data. An inbound data client can be completed or cancelled, in which case it will ignore any future inputs. It can also be awaited on.

Method Summary

Modifier and Type	Method and Description
void	awaitCompletion() Block until the client has completed reading from the inbound stream.
void	cancel() Cancels the client, causing it to drop any future inbound data.
void	complete() Mark the client as completed.
void	fail(java.lang.Throwable t) Mark the client as completed with an exception.
boolean	isDone() Returns true if the client is done, either via completing successfully or by being cancelled.

Method Detail

awaitCompletion

void awaitCompletion()
              throws java.lang.InterruptedException,
                     java.lang.Exception

Block until the client has completed reading from the inbound stream.

Throws:

java.lang.InterruptedException - if the client is interrupted before completing.

java.util.concurrent.CancellationException - if the client is cancelled before completing.

java.lang.Exception - if the client throws an exception while awaiting completion.

isDone

boolean isDone()

Returns true if the client is done, either via completing successfully or by being cancelled.

cancel

void cancel()

Cancels the client, causing it to drop any future inbound data.

complete

void complete()

Mark the client as completed.

fail

void fail(java.lang.Throwable t)

Mark the client as completed with an exception. Calls to awaitCompletion will terminate by throwing the provided exception.

Parameters:

t - the throwable that caused this client to fail