org.apache.drill.exec.rpc.user

Class UserServer.BitToUserConnection

java.lang.Object

org.apache.drill.exec.rpc.AbstractRemoteConnection

org.apache.drill.exec.rpc.AbstractServerConnection<UserServer.BitToUserConnection>

org.apache.drill.exec.rpc.user.UserServer.BitToUserConnection

All Implemented Interfaces:

AutoCloseable, ConnectionThrottle, EncryptionContext, RemoteConnection, ServerConnection<UserServer.BitToUserConnection>, UserClientConnection

Enclosing class:

UserServer

public class UserServer.BitToUserConnection
extends AbstractServerConnection<UserServer.BitToUserConnection>
implements UserClientConnection

Represents a client connection accepted by Foreman Drillbit's UserServer from a DrillClient. This connection is used to get hold of UserSession which stores all session related information like session options changed over the lifetime of this connection. There is a 1:1 mapping between a BitToUserConnection and a UserSession. This connection object is also used to send query data and result back to the client submitted as part of the session tied to this connection.

Field Summary

Fields inherited from class org.apache.drill.exec.rpc.AbstractRemoteConnection

saslCodec

Method Summary

Modifier and Type	Method and Description
void	channelClosed(RpcException ex) Called from the RpcBus's channel close handler to close all remaining resources associated with this connection.
void	close() Connection consumer wants to close connection.
void	decConnectionCounter()
void	finalizeSaslSession()
io.netty.util.concurrent.Future<Void>	getClosureFuture() Returns the Future which will be notified when this channel is closed.
protected org.slf4j.Logger	getLogger()
SocketAddress	getRemoteAddress()
UserSession	getSession()
void	incConnectionCounter()
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.

Methods inherited from class org.apache.drill.exec.rpc.AbstractServerConnection

changeHandlerTo, disposeSaslServer, getAllocator, getCurrentHandler, getSaslServer, initSaslServer, setEncryption, setMaxWrappedSize

Methods inherited from class org.apache.drill.exec.rpc.AbstractRemoteConnection

addSecurityHandlers, blockOnNotWritable, createNewRpcListener, getAndRemoveRpcOutcome, getChannel, getEncryptionCtxtString, getMaxWrappedSize, getName, getWrapSizeLimit, inEventLoop, isActive, isEncryptionEnabled, recordRemoteFailure, setAutoRead, setWrapSizeLimit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.drill.exec.rpc.RemoteConnection

addSecurityHandlers, blockOnNotWritable, createNewRpcListener, getAndRemoveRpcOutcome, getChannel, getName, inEventLoop, isActive, recordRemoteFailure

Methods inherited from interface org.apache.drill.exec.rpc.ConnectionThrottle

setAutoRead

Methods inherited from interface org.apache.drill.exec.rpc.EncryptionContext

getEncryptionCtxtString, getMaxWrappedSize, getWrapSizeLimit, isEncryptionEnabled, setWrapSizeLimit

Method Detail

finalizeSaslSession

public void finalizeSaslSession()
                         throws IOException

Specified by:

finalizeSaslSession in interface ServerConnection<UserServer.BitToUserConnection>

Overrides:

finalizeSaslSession in class AbstractServerConnection<UserServer.BitToUserConnection>

Throws:

IOException

getSession

public UserSession getSession()

Specified by:

getSession in interface UserClientConnection

Returns:

User session object.

getLogger

protected org.slf4j.Logger getLogger()

Specified by:

getLogger in class AbstractServerConnection<UserServer.BitToUserConnection>

sendResult

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

Description copied from interface: UserClientConnection

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

Specified by:

sendResult in interface UserClientConnection

Parameters:

listener - The listener

result - The query result to be sent

sendData

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

Description copied from interface: UserClientConnection

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

Specified by:

sendData in interface UserClientConnection

Parameters:

listener - The listener

data - The data to be sent

getClosureFuture

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

Description copied from interface: UserClientConnection

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

Specified by:

getClosureFuture in interface UserClientConnection

getRemoteAddress

public SocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface RemoteConnection

Specified by:

getRemoteAddress in interface UserClientConnection

Overrides:

getRemoteAddress in class AbstractRemoteConnection

Returns:

Return the client node address.

channelClosed

public void channelClosed(RpcException ex)

Description copied from class: AbstractRemoteConnection

Called from the RpcBus's channel close handler to close all remaining resources associated with this connection. Ensures that any pending back-pressure items are also unblocked so they can be thrown away.

Specified by:

channelClosed in interface RemoteConnection

Overrides:

channelClosed in class AbstractServerConnection<UserServer.BitToUserConnection>

Parameters:

ex - The exception that caused the channel to close.

close

public void close()

Description copied from class: AbstractRemoteConnection

Connection consumer wants to close connection. Initiate connection close and complete. This is a blocking call that ensures that the connection is closed before returning. As part of this call, the channel close handler will be triggered which will call channelClosed() above. The latter will happen in a separate thread while this method is blocking.

The check for isActive is not required here since channel can be in OPEN state without being active. We want to close in both the scenarios. A channel is in OPEN state when a socket is created for it before binding to an address.

For connection oriented transport protocol channel moves to ACTIVE state when a connection is established using this channel. We need to have channel in ACTIVE state NOT OPEN before we can send any message to remote endpoint. For connectionless transport protocol a sender can send data as soon as channel moves to OPEN state.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface RemoteConnection

Overrides:

close in class AbstractRemoteConnection

incConnectionCounter

public void incConnectionCounter()

Specified by:

incConnectionCounter in class AbstractRemoteConnection

decConnectionCounter

public void decConnectionCounter()

Specified by:

decConnectionCounter in class AbstractRemoteConnection