org.apache.drill.exec.rpc.user

Interface UserResultsListener

All Known Implementing Classes:

AwaitableUserResultsListener, LoggingResultsListener

public interface UserResultsListener

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

queryIdArrived

void queryIdArrived(UserBitShared.QueryId queryId)

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

Parameters:

queryId - sent by the server along Acks.OK

submissionFailed

void submissionFailed(UserException ex)

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

Parameters:

ex - exception describing the cause of the failure

dataArrived

void dataArrived(QueryDataBatch result,
                 ConnectionThrottle throttle)

A QueryData message was received

Parameters:

result - data batch received

throttle - connection throttle

queryCompleted

void queryCompleted(UserBitShared.QueryResult.QueryState state)

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)