Package org.apache.drill.exec.rpc.user

Class BlockingResultsListener

java.lang.Object

org.apache.drill.exec.rpc.user.BlockingResultsListener

All Implemented Interfaces:

UserResultsListener

public class BlockingResultsListener
extends Object
implements UserResultsListener

Constructor Summary

Constructors

Constructor	Description
BlockingResultsListener(Supplier<org.apache.drill.shaded.guava.com.google.common.base.Stopwatch> elapsedTimer, Supplier<Long> timeoutInMilliseconds, int batchQueueThrottlingThreshold)

Method Summary

Modifier and Type	Method	Description
void	awaitFirstMessage()
void	close()
void	dataArrived(QueryDataBatch result, ConnectionThrottle throttle)	A QueryData message was received
QueryDataBatch	getNext()	Gets the next batch of query results from the queue.
UserBitShared.QueryId	getQueryId()
boolean	isCompleted()
void	queryCompleted(UserBitShared.QueryResult.QueryState state)	The query has completed (successful completion or cancellation).
void	queryIdArrived(UserBitShared.QueryId queryId)	QueryId is available.
void	submissionFailed(UserException ex)	The query has failed.

Methods inherited from class java.lang.Object

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

Constructor Details

BlockingResultsListener

public BlockingResultsListener(Supplier<org.apache.drill.shaded.guava.com.google.common.base.Stopwatch> elapsedTimer,
 Supplier<Long> timeoutInMilliseconds,
 int batchQueueThrottlingThreshold)

Method Details

awaitFirstMessage

public void awaitFirstMessage()
                       throws InterruptedException,
SQLTimeoutException

Throws:

InterruptedException

SQLTimeoutException

queryIdArrived

public void queryIdArrived(UserBitShared.QueryId queryId)

Description copied from interface: UserResultsListener

QueryId is available. Called when a query is successfully submitted to the server.

Specified by:

queryIdArrived in interface UserResultsListener

Parameters:

queryId - sent by the server along Acks.OK

submissionFailed

public void submissionFailed(UserException ex)

Description copied from interface: UserResultsListener

The query has failed. Most likely called when the server returns a FAILED query state. Can also be called if dataArrived() throws an exception

Specified by:

submissionFailed in interface UserResultsListener

Parameters:

ex - exception describing the cause of the failure

dataArrived

public void dataArrived(QueryDataBatch result,
 ConnectionThrottle throttle)

Description copied from interface: UserResultsListener

A QueryData message was received

Specified by:

dataArrived in interface UserResultsListener

Parameters:

result - data batch received

throttle - connection throttle

queryCompleted

public void queryCompleted(UserBitShared.QueryResult.QueryState state)

Description copied from interface: UserResultsListener

The query has completed (successful completion or cancellation). The listener will not receive any other data or result message. Called when the server returns a terminal-non failing- state (COMPLETED or CANCELLED)

Specified by:

queryCompleted in interface UserResultsListener

getQueryId

public UserBitShared.QueryId getQueryId()

getNext

public QueryDataBatch getNext()
                       throws UserException,
InterruptedException,
SQLTimeoutException

Gets the next batch of query results from the queue.

Returns:

the next batch, or null after last batch has been returned

Throws:

UserException - if the query failed

InterruptedException - if waiting on the queue was interrupted

SQLTimeoutException

close

public void close()

isCompleted

public boolean isCompleted()