Package org.apache.beam.sdk.fn.data
Interface InboundDataClient
-
- All Known Implementing Classes:
BeamFnDataInboundObserver,CompletableFutureInboundDataClient
@Deprecated public interface InboundDataClientDeprecated.Migrate toBeamFnDataInboundObserver2.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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description voidawaitCompletion()Deprecated.Block until the client has completed reading from the inbound stream.voidcancel()Deprecated.Cancels the client, causing it to drop any future inbound data.voidcomplete()Deprecated.Mark the client as completed.voidfail(java.lang.Throwable t)Deprecated.Mark the client as completed with an exception.booleanisDone()Deprecated.Returns true if the client is done, either via completing successfully or by being cancelled.voidrunWhenComplete(java.lang.Runnable completeRunnable)Deprecated.Runs the runnable once the client has completed reading from the inbound stream.
-
-
-
Method Detail
-
awaitCompletion
void awaitCompletion() throws java.lang.InterruptedException, java.lang.ExceptionDeprecated.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.
-
runWhenComplete
void runWhenComplete(java.lang.Runnable completeRunnable)
Deprecated.Runs the runnable once the client has completed reading from the inbound stream.
-
isDone
boolean isDone()
Deprecated.Returns true if the client is done, either via completing successfully or by being cancelled.
-
cancel
void cancel()
Deprecated.Cancels the client, causing it to drop any future inbound data.
-
complete
void complete()
Deprecated.Mark the client as completed.
-
fail
void fail(java.lang.Throwable t)
Deprecated.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
-
-