org.apache.drill.exec.rpc.user

Class AwaitableUserResultsListener

java.lang.Object

org.apache.drill.exec.rpc.user.AwaitableUserResultsListener

All Implemented Interfaces:

UserResultsListener

public class AwaitableUserResultsListener
extends Object
implements UserResultsListener

General mechanism for waiting on the query to be executed

Constructor Summary

Constructors

Constructor and Description
AwaitableUserResultsListener(UserResultsListener child)

Method Summary

Modifier and Type	Method and Description
int	await()
void	dataArrived(QueryDataBatch result, ConnectionThrottle throttle) A QueryData message was received
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 Detail

AwaitableUserResultsListener

public AwaitableUserResultsListener(UserResultsListener child)

Parameters:

child - the listener responsible for consuming the data

Method Detail

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

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

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

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

await

public int await()
          throws Exception

Throws:

Exception