org.apache.drill.exec.rpc

Interface UserClientConnection

All Known Implementing Classes:

AbstractDisposableUserClientConnection, BaseWebUserConnection, StreamingHttpConnection, UserServer.BitToUserConnection, WebUserConnection, WebUserConnection.AnonWebUserConnection

public interface UserClientConnection

Interface for getting user session properties and interacting with user connection. Separating this interface from AbstractRemoteConnection implementation for user connection:

• Connection is passed to Foreman and Screen operators. Instead passing this interface exposes few details.
• Makes it easy to have wrappers around user connection which can be helpful to tap the messages and data going to the actual client.

Method Summary

Modifier and Type	Method and Description
io.netty.util.concurrent.Future<Void>	getClosureFuture() Returns the Future which will be notified when this channel is closed.
SocketAddress	getRemoteAddress()
UserSession	getSession()
void	sendData(RpcOutcomeListener<GeneralRPCProtos.Ack> listener, QueryDataPackage data) Send query data to client.
void	sendResult(RpcOutcomeListener<GeneralRPCProtos.Ack> listener, UserBitShared.QueryResult result) Send query result outcome to client.

Method Detail

getSession

UserSession getSession()

Returns:

User session object.

sendResult

void sendResult(RpcOutcomeListener<GeneralRPCProtos.Ack> listener,
                UserBitShared.QueryResult result)

Send query result outcome to client. Outcome is returned through listener.

Parameters:

listener - The listener

result - The query result to be sent

sendData

void sendData(RpcOutcomeListener<GeneralRPCProtos.Ack> listener,
              QueryDataPackage data)

Send query data to client. Outcome is returned through listener.

Parameters:

listener - The listener

data - The data to be sent

getClosureFuture

io.netty.util.concurrent.Future<Void> getClosureFuture()

Returns the Future which will be notified when this channel is closed. This method always returns the same future instance.

getRemoteAddress

SocketAddress getRemoteAddress()

Returns:

Return the client node address.