Module org.apache.arrow.flight.core

Package org.apache.arrow.flight

Class AsyncPutListener

java.lang.Object

org.apache.arrow.flight.AsyncPutListener

All Implemented Interfaces:

FlightClient.PutListener, FlightProducer.StreamListener<PutResult>

public class AsyncPutListener
extends Object
implements FlightClient.PutListener

A handler for server-sent application metadata messages during a Flight DoPut operation.

To handle messages, create an instance of this class overriding onNext(PutResult). The other methods should not be overridden.

Constructor Summary

Constructors

Constructor	Description
AsyncPutListener()

Method Summary

Modifier and Type	Method	Description
final void	getResult()	Wait for the stream to finish on the server side.
boolean	isCancelled()	Check if the call has been cancelled.
final void	onCompleted()	Indicate that the transmission is finished.
final void	onError(Throwable t)	Indicate an error to the client.
void	onNext(PutResult val)	Called when a message from the server is received.

Methods inherited from class java.lang.Object

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

Constructor Details

AsyncPutListener

public AsyncPutListener()

Method Details

getResult

public final void getResult()

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 final 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 final void onCompleted()

Description copied from interface: FlightProducer.StreamListener

Indicate that the transmission is finished.

Specified by:

onCompleted in interface FlightProducer.StreamListener<PutResult>

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