Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / exec / rpc / user / UserServer.BitToUserConnection.html
blob: 777e401eac15cdba5d5ab99dbd6d8eccf86d4038 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UserServer.BitToUserConnection (Drill : 1.20.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UserServer.BitToUserConnection (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UserServer.BitToUserConnection.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnectionConfig.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" target="_top">Frames</a></li>
<li><a href="UserServer.BitToUserConnection.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.drill.exec.rpc.AbstractRemoteConnection">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.drill.exec.rpc.user</div>
<h2 title="Class UserServer.BitToUserConnection" class="title">Class UserServer.BitToUserConnection</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html" title="class in org.apache.drill.exec.rpc">org.apache.drill.exec.rpc.AbstractRemoteConnection</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html" title="class in org.apache.drill.exec.rpc">org.apache.drill.exec.rpc.AbstractServerConnection</a>&lt;<a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" title="class in org.apache.drill.exec.rpc.user">UserServer.BitToUserConnection</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.drill.exec.rpc.user.UserServer.BitToUserConnection</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../../../org/apache/drill/exec/rpc/ConnectionThrottle.html" title="interface in org.apache.drill.exec.rpc">ConnectionThrottle</a>, <a href="../../../../../../org/apache/drill/exec/rpc/EncryptionContext.html" title="interface in org.apache.drill.exec.rpc">EncryptionContext</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html" title="interface in org.apache.drill.exec.rpc">RemoteConnection</a>, <a href="../../../../../../org/apache/drill/exec/rpc/ServerConnection.html" title="interface in org.apache.drill.exec.rpc">ServerConnection</a>&lt;<a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" title="class in org.apache.drill.exec.rpc.user">UserServer.BitToUserConnection</a>&gt;, <a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html" title="interface in org.apache.drill.exec.rpc">UserClientConnection</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.html" title="class in org.apache.drill.exec.rpc.user">UserServer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">UserServer.BitToUserConnection</span>
extends <a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html" title="class in org.apache.drill.exec.rpc">AbstractServerConnection</a>&lt;<a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" title="class in org.apache.drill.exec.rpc.user">UserServer.BitToUserConnection</a>&gt;
implements <a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html" title="interface in org.apache.drill.exec.rpc">UserClientConnection</a></pre>
<div class="block">Represents a client connection accepted by Foreman Drillbit's UserServer
from a DrillClient. This connection is used to get hold of
<a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html" title="class in org.apache.drill.exec.rpc.user"><code>UserSession</code></a> 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.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.rpc.AbstractRemoteConnection">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html" title="class in org.apache.drill.exec.rpc">AbstractRemoteConnection</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#saslCodec">saslCodec</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#channelClosed-org.apache.drill.exec.rpc.RpcException-">channelClosed</a></span>(<a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a>&nbsp;ex)</code>
<div class="block">Called from the RpcBus's channel close handler to close all remaining
resources associated with this connection.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#close--">close</a></span>()</code>
<div class="block">Connection consumer wants to close connection.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#decConnectionCounter--">decConnectionCounter</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#finalizeSaslSession--">finalizeSaslSession</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>io.netty.util.concurrent.Future&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#getClosureFuture--">getClosureFuture</a></span>()</code>
<div class="block">Returns the <code>Future</code> which will be notified when this
channel is closed.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#getLogger--">getLogger</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#getRemoteAddress--">getRemoteAddress</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html" title="class in org.apache.drill.exec.rpc.user">UserSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#getSession--">getSession</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#incConnectionCounter--">incConnectionCounter</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#sendData-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.physical.impl.materialize.QueryDataPackage-">sendData</a></span>(<a href="../../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a>&lt;<a href="../../../../../../org/apache/drill/exec/proto/GeneralRPCProtos.Ack.html" title="class in org.apache.drill.exec.proto">GeneralRPCProtos.Ack</a>&gt;&nbsp;listener,
<a href="../../../../../../org/apache/drill/exec/physical/impl/materialize/QueryDataPackage.html" title="interface in org.apache.drill.exec.physical.impl.materialize">QueryDataPackage</a>&nbsp;data)</code>
<div class="block">Send query data to client.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html#sendResult-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.proto.UserBitShared.QueryResult-">sendResult</a></span>(<a href="../../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a>&lt;<a href="../../../../../../org/apache/drill/exec/proto/GeneralRPCProtos.Ack.html" title="class in org.apache.drill.exec.proto">GeneralRPCProtos.Ack</a>&gt;&nbsp;listener,
<a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.QueryResult.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryResult</a>&nbsp;result)</code>
<div class="block">Send query result outcome to client.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.rpc.AbstractServerConnection">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html" title="class in org.apache.drill.exec.rpc">AbstractServerConnection</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#changeHandlerTo-org.apache.drill.exec.rpc.RequestHandler-">changeHandlerTo</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#disposeSaslServer--">disposeSaslServer</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#getAllocator--">getAllocator</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#getCurrentHandler--">getCurrentHandler</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#getSaslServer--">getSaslServer</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#initSaslServer-java.lang.String-">initSaslServer</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#setEncryption-boolean-">setEncryption</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#setMaxWrappedSize-int-">setMaxWrappedSize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.rpc.AbstractRemoteConnection">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html" title="class in org.apache.drill.exec.rpc">AbstractRemoteConnection</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#addSecurityHandlers--">addSecurityHandlers</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#blockOnNotWritable-org.apache.drill.exec.rpc.RpcOutcomeListener-">blockOnNotWritable</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#createNewRpcListener-org.apache.drill.exec.rpc.RpcOutcomeListener-java.lang.Class-">createNewRpcListener</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#getAndRemoveRpcOutcome-int-int-java.lang.Class-">getAndRemoveRpcOutcome</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#getChannel--">getChannel</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#getEncryptionCtxtString--">getEncryptionCtxtString</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#getMaxWrappedSize--">getMaxWrappedSize</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#getName--">getName</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#getWrapSizeLimit--">getWrapSizeLimit</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#inEventLoop--">inEventLoop</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#isActive--">isActive</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#isEncryptionEnabled--">isEncryptionEnabled</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#recordRemoteFailure-int-org.apache.drill.exec.proto.UserBitShared.DrillPBError-">recordRemoteFailure</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#setAutoRead-boolean-">setAutoRead</a>, <a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#setWrapSizeLimit-int-">setWrapSizeLimit</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.rpc.RemoteConnection">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html" title="interface in org.apache.drill.exec.rpc">RemoteConnection</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#addSecurityHandlers--">addSecurityHandlers</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#blockOnNotWritable-org.apache.drill.exec.rpc.RpcOutcomeListener-">blockOnNotWritable</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#createNewRpcListener-org.apache.drill.exec.rpc.RpcOutcomeListener-java.lang.Class-">createNewRpcListener</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#getAndRemoveRpcOutcome-int-int-java.lang.Class-">getAndRemoveRpcOutcome</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#getChannel--">getChannel</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#getName--">getName</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#inEventLoop--">inEventLoop</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#isActive--">isActive</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#recordRemoteFailure-int-org.apache.drill.exec.proto.UserBitShared.DrillPBError-">recordRemoteFailure</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.rpc.ConnectionThrottle">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/ConnectionThrottle.html" title="interface in org.apache.drill.exec.rpc">ConnectionThrottle</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/rpc/ConnectionThrottle.html#setAutoRead-boolean-">setAutoRead</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.rpc.EncryptionContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/EncryptionContext.html" title="interface in org.apache.drill.exec.rpc">EncryptionContext</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/rpc/EncryptionContext.html#getEncryptionCtxtString--">getEncryptionCtxtString</a>, <a href="../../../../../../org/apache/drill/exec/rpc/EncryptionContext.html#getMaxWrappedSize--">getMaxWrappedSize</a>, <a href="../../../../../../org/apache/drill/exec/rpc/EncryptionContext.html#getWrapSizeLimit--">getWrapSizeLimit</a>, <a href="../../../../../../org/apache/drill/exec/rpc/EncryptionContext.html#isEncryptionEnabled--">isEncryptionEnabled</a>, <a href="../../../../../../org/apache/drill/exec/rpc/EncryptionContext.html#setWrapSizeLimit-int-">setWrapSizeLimit</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="finalizeSaslSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finalizeSaslSession</h4>
<pre>public&nbsp;void&nbsp;finalizeSaslSession()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/ServerConnection.html#finalizeSaslSession--">finalizeSaslSession</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/ServerConnection.html" title="interface in org.apache.drill.exec.rpc">ServerConnection</a>&lt;<a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" title="class in org.apache.drill.exec.rpc.user">UserServer.BitToUserConnection</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#finalizeSaslSession--">finalizeSaslSession</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html" title="class in org.apache.drill.exec.rpc">AbstractServerConnection</a>&lt;<a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" title="class in org.apache.drill.exec.rpc.user">UserServer.BitToUserConnection</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html" title="class in org.apache.drill.exec.rpc.user">UserSession</a>&nbsp;getSession()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html#getSession--">getSession</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html" title="interface in org.apache.drill.exec.rpc">UserClientConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>User session object.</dd>
</dl>
</li>
</ul>
<a name="getLogger--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogger</h4>
<pre>protected&nbsp;org.slf4j.Logger&nbsp;getLogger()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#getLogger--">getLogger</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html" title="class in org.apache.drill.exec.rpc">AbstractServerConnection</a>&lt;<a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" title="class in org.apache.drill.exec.rpc.user">UserServer.BitToUserConnection</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="sendResult-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.proto.UserBitShared.QueryResult-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendResult</h4>
<pre>public&nbsp;void&nbsp;sendResult(<a href="../../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a>&lt;<a href="../../../../../../org/apache/drill/exec/proto/GeneralRPCProtos.Ack.html" title="class in org.apache.drill.exec.proto">GeneralRPCProtos.Ack</a>&gt;&nbsp;listener,
<a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.QueryResult.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryResult</a>&nbsp;result)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html#sendResult-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.proto.UserBitShared.QueryResult-">UserClientConnection</a></code></span></div>
<div class="block">Send query result outcome to client. Outcome is returned through <code>listener</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html#sendResult-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.proto.UserBitShared.QueryResult-">sendResult</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html" title="interface in org.apache.drill.exec.rpc">UserClientConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The listener</dd>
<dd><code>result</code> - The query result to be sent</dd>
</dl>
</li>
</ul>
<a name="sendData-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.physical.impl.materialize.QueryDataPackage-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendData</h4>
<pre>public&nbsp;void&nbsp;sendData(<a href="../../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a>&lt;<a href="../../../../../../org/apache/drill/exec/proto/GeneralRPCProtos.Ack.html" title="class in org.apache.drill.exec.proto">GeneralRPCProtos.Ack</a>&gt;&nbsp;listener,
<a href="../../../../../../org/apache/drill/exec/physical/impl/materialize/QueryDataPackage.html" title="interface in org.apache.drill.exec.physical.impl.materialize">QueryDataPackage</a>&nbsp;data)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html#sendData-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.physical.impl.materialize.QueryDataPackage-">UserClientConnection</a></code></span></div>
<div class="block">Send query data to client. Outcome is returned through <code>listener</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html#sendData-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.physical.impl.materialize.QueryDataPackage-">sendData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html" title="interface in org.apache.drill.exec.rpc">UserClientConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The listener</dd>
<dd><code>data</code> - The data to be sent</dd>
</dl>
</li>
</ul>
<a name="getClosureFuture--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClosureFuture</h4>
<pre>public&nbsp;io.netty.util.concurrent.Future&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;&nbsp;getClosureFuture()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html#getClosureFuture--">UserClientConnection</a></code></span></div>
<div class="block">Returns the <code>Future</code> which will be notified when this
channel is closed. This method always returns the same future instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html#getClosureFuture--">getClosureFuture</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html" title="interface in org.apache.drill.exec.rpc">UserClientConnection</a></code></dd>
</dl>
</li>
</ul>
<a name="getRemoteAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a>&nbsp;getRemoteAddress()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#getRemoteAddress--">getRemoteAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html" title="interface in org.apache.drill.exec.rpc">RemoteConnection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html#getRemoteAddress--">getRemoteAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/UserClientConnection.html" title="interface in org.apache.drill.exec.rpc">UserClientConnection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#getRemoteAddress--">getRemoteAddress</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html" title="class in org.apache.drill.exec.rpc">AbstractRemoteConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Return the client node address.</dd>
</dl>
</li>
</ul>
<a name="channelClosed-org.apache.drill.exec.rpc.RpcException-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>channelClosed</h4>
<pre>public&nbsp;void&nbsp;channelClosed(<a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a>&nbsp;ex)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#channelClosed-org.apache.drill.exec.rpc.RpcException-">AbstractRemoteConnection</a></code></span></div>
<div class="block">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.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#channelClosed-org.apache.drill.exec.rpc.RpcException-">channelClosed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html" title="interface in org.apache.drill.exec.rpc">RemoteConnection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html#channelClosed-org.apache.drill.exec.rpc.RpcException-">channelClosed</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html" title="class in org.apache.drill.exec.rpc">AbstractServerConnection</a>&lt;<a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" title="class in org.apache.drill.exec.rpc.user">UserServer.BitToUserConnection</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ex</code> - The exception that caused the channel to close.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#close--">AbstractRemoteConnection</a></code></span></div>
<div class="block">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.
<p>
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.
<li>
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.
</li>
<li>
For connectionless transport protocol a sender can send data as soon as channel moves to OPEN state.
</li>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/RemoteConnection.html" title="interface in org.apache.drill.exec.rpc">RemoteConnection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#close--">close</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html" title="class in org.apache.drill.exec.rpc">AbstractRemoteConnection</a></code></dd>
</dl>
</li>
</ul>
<a name="incConnectionCounter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incConnectionCounter</h4>
<pre>public&nbsp;void&nbsp;incConnectionCounter()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#incConnectionCounter--">incConnectionCounter</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html" title="class in org.apache.drill.exec.rpc">AbstractRemoteConnection</a></code></dd>
</dl>
</li>
</ul>
<a name="decConnectionCounter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>decConnectionCounter</h4>
<pre>public&nbsp;void&nbsp;decConnectionCounter()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html#decConnectionCounter--">decConnectionCounter</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html" title="class in org.apache.drill.exec.rpc">AbstractRemoteConnection</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UserServer.BitToUserConnection.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnectionConfig.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" target="_top">Frames</a></li>
<li><a href="UserServer.BitToUserConnection.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.drill.exec.rpc.AbstractRemoteConnection">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>