org.apache.arrow.flight

Class SyncPutListener

java.lang.Object

org.apache.arrow.flight.SyncPutListener

All Implemented Interfaces:

AutoCloseable, FlightClient.PutListener, FlightProducer.StreamListener<PutResult>

public final class SyncPutListener
extends Object
implements FlightClient.PutListener, AutoCloseable

A listener for server-sent application metadata messages during a Flight DoPut. This class wraps the messages in a synchronous interface.

Constructor Summary

Constructors

Constructor and Description
SyncPutListener()

Method Summary

Modifier and Type	Method and Description
void	close()
void	getResult() Wait for the stream to finish on the server side.
boolean	isCancelled() Check if the call has been cancelled.
void	onCompleted() Indicate that the transmission is finished.
void	onError(Throwable t) Indicate an error to the client.
void	onNext(PutResult val) Called when a message from the server is received.
PutResult	poll(long timeout, TimeUnit unit) Get the next message from the server, blocking for the specified amount of time until it is available.
PutResult	read() Get the next message from the server, blocking until it is available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyncPutListener

public SyncPutListener()

Method Detail

read

public PutResult read()
               throws InterruptedException,
                      ExecutionException

Get the next message from the server, blocking until it is available.

Returns:

The next message, or null if the server is done sending messages. The caller assumes ownership of the metadata and must remember to close it.

Throws:

InterruptedException - if interrupted while waiting.

ExecutionException - if the server sent an error, or if there was an internal error.

poll

public PutResult poll(long timeout,
                      TimeUnit unit)
               throws InterruptedException,
                      ExecutionException

Get the next message from the server, blocking for the specified amount of time until it is available.

Returns:

The next message, or null if the server is done sending messages or no message arrived before the timeout. The caller assumes ownership of the metadata and must remember to close it.

Throws:

InterruptedException - if interrupted while waiting.

ExecutionException - if the server sent an error, or if there was an internal error.

getResult

public void getResult()

Description copied from interface: FlightClient.PutListener

Wait for the stream to finish on the server side. You must call this to be notified of any errors that may have happened during the upload.

Specified by:

getResult in interface FlightClient.PutListener

onNext

public void onNext(PutResult val)

Description copied from interface: FlightClient.PutListener

Called when a message from the server is received.

Specified by:

onNext in interface FlightClient.PutListener

Specified by:

onNext in interface FlightProducer.StreamListener<PutResult>

Parameters:

val - The application metadata. This buffer will be reclaimed once onNext returns; you must retain a reference to use it outside this method.

onError

public void onError(Throwable t)

Description copied from interface: FlightProducer.StreamListener

Indicate an error to the client.

Terminates the stream; do not call FlightProducer.StreamListener.onCompleted().

Specified by:

onError in interface FlightProducer.StreamListener<PutResult>

onCompleted

public void onCompleted()

Description copied from interface: FlightProducer.StreamListener

Indicate that the transmission is finished.

Specified by:

onCompleted in interface FlightProducer.StreamListener<PutResult>

close

public void close()

Specified by:

close in interface AutoCloseable

isCancelled

public boolean isCancelled()

Description copied from interface: FlightClient.PutListener

Check if the call has been cancelled.

By default, this always returns false. Implementations should provide an appropriate implementation, as otherwise, a DoPut operation may inadvertently block forever.

Specified by:

isCancelled in interface FlightClient.PutListener