blob: 8765331e3880a81cea7baf86fad39125c31ca58d [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>RemoteConnection (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="RemoteConnection (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RemoteConnection.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/ReconnectingConnection.ConnectionListeningFuture.html" title="class in org.apache.drill.exec.rpc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/rpc/RequestHandler.html" title="interface in org.apache.drill.exec.rpc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/rpc/RemoteConnection.html" target="_top">Frames</a></li>
<li><a href="RemoteConnection.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>Field&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</div>
<h2 title="Interface RemoteConnection" class="title">Interface RemoteConnection</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</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></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/drill/exec/rpc/ClientConnection.html" title="interface in org.apache.drill.exec.rpc">ClientConnection</a>, <a href="../../../../../org/apache/drill/exec/rpc/ServerConnection.html" title="interface in org.apache.drill.exec.rpc">ServerConnection</a>&lt;S&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/drill/exec/rpc/AbstractClientConnection.html" title="class in org.apache.drill.exec.rpc">AbstractClientConnection</a>, <a href="../../../../../org/apache/drill/exec/rpc/AbstractRemoteConnection.html" title="class in org.apache.drill.exec.rpc">AbstractRemoteConnection</a>, <a href="../../../../../org/apache/drill/exec/rpc/AbstractServerConnection.html" title="class in org.apache.drill.exec.rpc">AbstractServerConnection</a>, <a href="../../../../../org/apache/drill/exec/rpc/control/ControlConnection.html" title="class in org.apache.drill.exec.rpc.control">ControlConnection</a>, <a href="../../../../../org/apache/drill/exec/rpc/data/DataClientConnection.html" title="class in org.apache.drill.exec.rpc.data">DataClientConnection</a>, <a href="../../../../../org/apache/drill/exec/rpc/data/DataServerConnection.html" title="class in org.apache.drill.exec.rpc.data">DataServerConnection</a>, <a href="../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>, <a href="../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnection.html" title="class in org.apache.drill.exec.rpc.user">UserServer.BitToUserConnection</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RemoteConnection</span>
extends <a href="../../../../../org/apache/drill/exec/rpc/ConnectionThrottle.html" title="interface in org.apache.drill.exec.rpc">ConnectionThrottle</a>, <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></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/RemoteConnection.html#addSecurityHandlers--">addSecurityHandlers</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#blockOnNotWritable-org.apache.drill.exec.rpc.RpcOutcomeListener-">blockOnNotWritable</a></span>(<a href="../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a>&lt;?&gt;&nbsp;listener)</code>&nbsp;</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/RemoteConnection.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>&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/RemoteConnection.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/ChannelListenerWithCoordinationId.html" title="interface in org.apache.drill.exec.rpc">ChannelListenerWithCoordinationId</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#createNewRpcListener-org.apache.drill.exec.rpc.RpcOutcomeListener-java.lang.Class-">createNewRpcListener</a></span>(<a href="../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a>&lt;V&gt;&nbsp;handler,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;V&gt;&nbsp;clazz)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#getAllocator--">getAllocator</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/RpcOutcome.html" title="interface in org.apache.drill.exec.rpc">RpcOutcome</a>&lt;V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#getAndRemoveRpcOutcome-int-int-java.lang.Class-">getAndRemoveRpcOutcome</a></span>(int&nbsp;rpcType,
int&nbsp;coordinationId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;V&gt;&nbsp;clazz)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>io.netty.channel.Channel</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#getChannel--">getChannel</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#getName--">getName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<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/RemoteConnection.html#getRemoteAddress--">getRemoteAddress</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#inEventLoop--">inEventLoop</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#isActive--">isActive</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/rpc/RemoteConnection.html#recordRemoteFailure-int-org.apache.drill.exec.proto.UserBitShared.DrillPBError-">recordRemoteFailure</a></span>(int&nbsp;coordinationId,
<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.DrillPBError.html" title="class in org.apache.drill.exec.proto">UserBitShared.DrillPBError</a>&nbsp;failure)</code>&nbsp;</td>
</tr>
</table>
<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>
</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="inEventLoop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inEventLoop</h4>
<pre>boolean&nbsp;inEventLoop()</pre>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
</li>
</ul>
<a name="getAllocator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllocator</h4>
<pre><a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a>&nbsp;getAllocator()</pre>
</li>
</ul>
<a name="getChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChannel</h4>
<pre>io.netty.channel.Channel&nbsp;getChannel()</pre>
</li>
</ul>
<a name="blockOnNotWritable-org.apache.drill.exec.rpc.RpcOutcomeListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>blockOnNotWritable</h4>
<pre>boolean&nbsp;blockOnNotWritable(<a href="../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a>&lt;?&gt;&nbsp;listener)</pre>
</li>
</ul>
<a name="isActive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isActive</h4>
<pre>boolean&nbsp;isActive()</pre>
</li>
</ul>
<a name="getAndRemoveRpcOutcome-int-int-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAndRemoveRpcOutcome</h4>
<pre>&lt;V&gt;&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/RpcOutcome.html" title="interface in org.apache.drill.exec.rpc">RpcOutcome</a>&lt;V&gt;&nbsp;getAndRemoveRpcOutcome(int&nbsp;rpcType,
int&nbsp;coordinationId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;V&gt;&nbsp;clazz)</pre>
</li>
</ul>
<a name="createNewRpcListener-org.apache.drill.exec.rpc.RpcOutcomeListener-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNewRpcListener</h4>
<pre>&lt;V&gt;&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/ChannelListenerWithCoordinationId.html" title="interface in org.apache.drill.exec.rpc">ChannelListenerWithCoordinationId</a>&nbsp;createNewRpcListener(<a href="../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a>&lt;V&gt;&nbsp;handler,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;V&gt;&nbsp;clazz)</pre>
</li>
</ul>
<a name="recordRemoteFailure-int-org.apache.drill.exec.proto.UserBitShared.DrillPBError-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recordRemoteFailure</h4>
<pre>void&nbsp;recordRemoteFailure(int&nbsp;coordinationId,
<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.DrillPBError.html" title="class in org.apache.drill.exec.proto">UserBitShared.DrillPBError</a>&nbsp;failure)</pre>
</li>
</ul>
<a name="channelClosed-org.apache.drill.exec.rpc.RpcException-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>channelClosed</h4>
<pre>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>
</li>
</ul>
<a name="getRemoteAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre><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>
</li>
</ul>
<a name="addSecurityHandlers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSecurityHandlers</h4>
<pre>void&nbsp;addSecurityHandlers()</pre>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()</pre>
<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>
</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/RemoteConnection.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/ReconnectingConnection.ConnectionListeningFuture.html" title="class in org.apache.drill.exec.rpc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/rpc/RequestHandler.html" title="interface in org.apache.drill.exec.rpc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/rpc/RemoteConnection.html" target="_top">Frames</a></li>
<li><a href="RemoteConnection.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>Field&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>