Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / org / apache / heron / common / network / HeronClient.html
blob: 043a531d59b050ea46db8ed212538b0b274e46db [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>HeronClient (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HeronClient (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.heron.common.network</a></div>
<h2 title="Class HeronClient" class="title">Class HeronClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.common.network.HeronClient</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../basics/ISelectHandler.html" title="interface in org.apache.heron.common.basics">ISelectHandler</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../testhelpers/HeronServerTester.AbstractTestClient.html" title="class in org.apache.heron.common.testhelpers">HeronServerTester.AbstractTestClient</a></code>, <code><a href="../../metricsmgr/sink/metricscache/MetricsCacheClient.html" title="class in org.apache.heron.metricsmgr.sink.metricscache">MetricsCacheClient</a></code>, <code><a href="../../network/MetricsManagerClient.html" title="class in org.apache.heron.network">MetricsManagerClient</a></code>, <code><a href="../../network/StreamManagerClient.html" title="class in org.apache.heron.network">StreamManagerClient</a></code>, <code><a href="../../metricsmgr/sink/tmanager/TManagerClient.html" title="class in org.apache.heron.metricsmgr.sink.tmanager">TManagerClient</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">HeronClient</span>
extends java.lang.Object
implements <a href="../basics/ISelectHandler.html" title="interface in org.apache.heron.common.basics">ISelectHandler</a></pre>
<div class="block">Implements this class could handle some following socket related behaviors:
1. handleRead(SelectableChannel), which read data from a socket and convert into incomingPacket.
It could handle the conditions of closedConnection, normal Reading and partial Reading. When an
incomingPacket is read, it will be pass to handlePacket(), which will convert incomingPackets to
messages and call onIncomingMessage(message), which should be implemented by its child class.
<p>
2. handleWrite(SelectableChannel), which will try to get outgoing message by calling getOutgoingMessage(),
pack the outgoing message into OutgoingPacket and write to the sockets.
<p>
3. handleConnect(SelectableChannel), which handles some basic setup when this client connect to
remote endpoint.
<p>
4. handleAccept(SelectableChannel).
<p>
5. handleError(SelectableChannel).
Remember, the socket client will register Read when the socket is connectible. However, it will
register Write when having something to write since the socket in most cases is writable.
To implement this, we will add the check whether write is needed into persistent tasks.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>,&#8203;java.lang.Object&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextMap">contextMap</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;com.google.protobuf.Message.Builder&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageMap">messageMap</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>,&#8203;com.google.protobuf.Message.Builder&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#responseMessageMap">responseMessageMap</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.common.basics.NIOLooper,java.lang.String,int,org.apache.heron.common.network.HeronSocketOptions)">HeronClient</a></span>&#8203;(<a href="../basics/NIOLooper.html" title="class in org.apache.heron.common.basics">NIOLooper</a>&nbsp;s,
java.lang.String&nbsp;host,
int&nbsp;port,
<a href="HeronSocketOptions.html" title="class in org.apache.heron.common.network">HeronSocketOptions</a>&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Constructor</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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><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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forceFlushWithBestEffort()">forceFlushWithBestEffort</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>,&#8203;java.lang.Object&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContextMap()">getContextMap</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;com.google.protobuf.Message.Builder&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageMap()">getMessageMap</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../basics/NIOLooper.html" title="class in org.apache.heron.common.basics">NIOLooper</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNIOLooper()">getNIOLooper</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutstandingPackets()">getOutstandingPackets</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>,&#8203;com.google.protobuf.Message.Builder&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResponseMessageMap()">getResponseMessageMap</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected java.nio.channels.SocketChannel</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSocketChannel()">getSocketChannel</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <a href="SocketChannelHelper.html" title="class in org.apache.heron.common.network">SocketChannelHelper</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSocketChannelHelper()">getSocketChannelHelper</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleAccept(java.nio.channels.SelectableChannel)">handleAccept</a></span>&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</code></th>
<td class="colLast">
<div class="block">Handle a SelectableChannel when it is acceptable</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleConnect(java.nio.channels.SelectableChannel)">handleConnect</a></span>&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</code></th>
<td class="colLast">
<div class="block">Handle a SelectableChannel when it is connectible</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleError(java.nio.channels.SelectableChannel)">handleError</a></span>&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</code></th>
<td class="colLast">
<div class="block">Handle a SelectableChannel when it meets some errors</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handlePacket(org.apache.heron.common.network.IncomingPacket)">handlePacket</a></span>&#8203;(<a href="IncomingPacket.html" title="class in org.apache.heron.common.network">IncomingPacket</a>&nbsp;incomingPacket)</code></th>
<td class="colLast">
<div class="block">Handle an incomingPacket and if necessary,
convert it to Message and call onIncomingMessage() to handle it</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleRead(java.nio.channels.SelectableChannel)">handleRead</a></span>&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</code></th>
<td class="colLast">
<div class="block">Handle a SelectableChannel when it is readable</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleTimeout(org.apache.heron.common.network.REQID)">handleTimeout</a></span>&#8203;(<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>&nbsp;rid)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleWrite(java.nio.channels.SelectableChannel)">handleWrite</a></span>&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</code></th>
<td class="colLast">
<div class="block">Handle a SelectableChannel when it is writable</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isConnected()">isConnected</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClose()">onClose</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onConnect(org.apache.heron.common.network.StatusCode)">onConnect</a></span>&#8203;(<a href="StatusCode.html" title="enum in org.apache.heron.common.network">StatusCode</a>&nbsp;status)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onError()">onError</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onIncomingMessage(com.google.protobuf.Message)">onIncomingMessage</a></span>&#8203;(com.google.protobuf.Message&nbsp;message)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponse(org.apache.heron.common.network.StatusCode,java.lang.Object,com.google.protobuf.Message)">onResponse</a></span>&#8203;(<a href="StatusCode.html" title="enum in org.apache.heron.common.network">StatusCode</a>&nbsp;status,
java.lang.Object&nbsp;ctx,
com.google.protobuf.Message&nbsp;response)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerOnMessage(com.google.protobuf.Message.Builder)">registerOnMessage</a></span>&#8203;(com.google.protobuf.Message.Builder&nbsp;builder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendMessage(com.google.protobuf.Message)">sendMessage</a></span>&#8203;(com.google.protobuf.Message&nbsp;message)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendRequest(com.google.protobuf.Message,com.google.protobuf.Message.Builder)">sendRequest</a></span>&#8203;(com.google.protobuf.Message&nbsp;request,
com.google.protobuf.Message.Builder&nbsp;responseBuilder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendRequest(com.google.protobuf.Message,java.lang.Object,com.google.protobuf.Message.Builder,java.time.Duration)">sendRequest</a></span>&#8203;(com.google.protobuf.Message&nbsp;request,
java.lang.Object&nbsp;context,
com.google.protobuf.Message.Builder&nbsp;responseBuilder,
java.time.Duration&nbsp;timeout)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startReading()">startReading</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startWriting()">startWriting</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop()">stop</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stopReading()">stopReading</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stopWriting()">stopWriting</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="contextMap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contextMap</h4>
<pre>protected&nbsp;java.util.Map&lt;<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>,&#8203;java.lang.Object&gt; contextMap</pre>
</li>
</ul>
<a id="responseMessageMap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>responseMessageMap</h4>
<pre>protected&nbsp;java.util.Map&lt;<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>,&#8203;com.google.protobuf.Message.Builder&gt; responseMessageMap</pre>
</li>
</ul>
<a id="messageMap">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>messageMap</h4>
<pre>protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;com.google.protobuf.Message.Builder&gt; messageMap</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.heron.common.basics.NIOLooper,java.lang.String,int,org.apache.heron.common.network.HeronSocketOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HeronClient</h4>
<pre>public&nbsp;HeronClient&#8203;(<a href="../basics/NIOLooper.html" title="class in org.apache.heron.common.basics">NIOLooper</a>&nbsp;s,
java.lang.String&nbsp;host,
int&nbsp;port,
<a href="HeronSocketOptions.html" title="class in org.apache.heron.common.network">HeronSocketOptions</a>&nbsp;options)</pre>
<div class="block">Constructor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the NIOLooper bind with this socket client</dd>
<dd><code>host</code> - the host of remote endpoint to communicate with</dd>
<dd><code>port</code> - the port of remote endpoint to communicate with</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="registerOnMessage(com.google.protobuf.Message.Builder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerOnMessage</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;registerOnMessage&#8203;(com.google.protobuf.Message.Builder&nbsp;builder)</pre>
</li>
</ul>
<a id="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;start()</pre>
</li>
</ul>
<a id="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stop()</pre>
</li>
</ul>
<a id="handleRead(java.nio.channels.SelectableChannel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleRead</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleRead&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../basics/ISelectHandler.html#handleRead(java.nio.channels.SelectableChannel)">ISelectHandler</a></code></span></div>
<div class="block">Handle a SelectableChannel when it is readable</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../basics/ISelectHandler.html#handleRead(java.nio.channels.SelectableChannel)">handleRead</a></code>&nbsp;in interface&nbsp;<code><a href="../basics/ISelectHandler.html" title="interface in org.apache.heron.common.basics">ISelectHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - the channel ISelectHandler with handle with</dd>
</dl>
</li>
</ul>
<a id="handleWrite(java.nio.channels.SelectableChannel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleWrite</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleWrite&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../basics/ISelectHandler.html#handleWrite(java.nio.channels.SelectableChannel)">ISelectHandler</a></code></span></div>
<div class="block">Handle a SelectableChannel when it is writable</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../basics/ISelectHandler.html#handleWrite(java.nio.channels.SelectableChannel)">handleWrite</a></code>&nbsp;in interface&nbsp;<code><a href="../basics/ISelectHandler.html" title="interface in org.apache.heron.common.basics">ISelectHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - the channel ISelectHandler with handle with</dd>
</dl>
</li>
</ul>
<a id="sendRequest(com.google.protobuf.Message,java.lang.Object,com.google.protobuf.Message.Builder,java.time.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendRequest</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendRequest&#8203;(com.google.protobuf.Message&nbsp;request,
java.lang.Object&nbsp;context,
com.google.protobuf.Message.Builder&nbsp;responseBuilder,
java.time.Duration&nbsp;timeout)</pre>
</li>
</ul>
<a id="sendRequest(com.google.protobuf.Message,com.google.protobuf.Message.Builder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendRequest</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendRequest&#8203;(com.google.protobuf.Message&nbsp;request,
com.google.protobuf.Message.Builder&nbsp;responseBuilder)</pre>
</li>
</ul>
<a id="sendMessage(com.google.protobuf.Message)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessage</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendMessage&#8203;(com.google.protobuf.Message&nbsp;message)</pre>
</li>
</ul>
<a id="isConnected()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnected</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isConnected()</pre>
</li>
</ul>
<a id="getNIOLooper()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNIOLooper</h4>
<pre class="methodSignature">public&nbsp;<a href="../basics/NIOLooper.html" title="class in org.apache.heron.common.basics">NIOLooper</a>&nbsp;getNIOLooper()</pre>
</li>
</ul>
<a id="handleAccept(java.nio.channels.SelectableChannel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleAccept</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleAccept&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../basics/ISelectHandler.html#handleAccept(java.nio.channels.SelectableChannel)">ISelectHandler</a></code></span></div>
<div class="block">Handle a SelectableChannel when it is acceptable</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../basics/ISelectHandler.html#handleAccept(java.nio.channels.SelectableChannel)">handleAccept</a></code>&nbsp;in interface&nbsp;<code><a href="../basics/ISelectHandler.html" title="interface in org.apache.heron.common.basics">ISelectHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - the channel ISelectHandler with handle with</dd>
</dl>
</li>
</ul>
<a id="handleConnect(java.nio.channels.SelectableChannel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleConnect</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleConnect&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../basics/ISelectHandler.html#handleConnect(java.nio.channels.SelectableChannel)">ISelectHandler</a></code></span></div>
<div class="block">Handle a SelectableChannel when it is connectible</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../basics/ISelectHandler.html#handleConnect(java.nio.channels.SelectableChannel)">handleConnect</a></code>&nbsp;in interface&nbsp;<code><a href="../basics/ISelectHandler.html" title="interface in org.apache.heron.common.basics">ISelectHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - the channel ISelectHandler with handle with</dd>
</dl>
</li>
</ul>
<a id="handlePacket(org.apache.heron.common.network.IncomingPacket)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handlePacket</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;handlePacket&#8203;(<a href="IncomingPacket.html" title="class in org.apache.heron.common.network">IncomingPacket</a>&nbsp;incomingPacket)</pre>
<div class="block">Handle an incomingPacket and if necessary,
convert it to Message and call onIncomingMessage() to handle it</div>
</li>
</ul>
<a id="handleTimeout(org.apache.heron.common.network.REQID)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleTimeout</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;handleTimeout&#8203;(<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>&nbsp;rid)</pre>
</li>
</ul>
<a id="handleError(java.nio.channels.SelectableChannel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleError</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleError&#8203;(java.nio.channels.SelectableChannel&nbsp;channel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../basics/ISelectHandler.html#handleError(java.nio.channels.SelectableChannel)">ISelectHandler</a></code></span></div>
<div class="block">Handle a SelectableChannel when it meets some errors</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../basics/ISelectHandler.html#handleError(java.nio.channels.SelectableChannel)">handleError</a></code>&nbsp;in interface&nbsp;<code><a href="../basics/ISelectHandler.html" title="interface in org.apache.heron.common.basics">ISelectHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - the channel ISelectHandler with handle with</dd>
</dl>
</li>
</ul>
<a id="startReading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startReading</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;startReading()</pre>
</li>
</ul>
<a id="stopReading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopReading</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stopReading()</pre>
</li>
</ul>
<a id="startWriting()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startWriting</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;startWriting()</pre>
</li>
</ul>
<a id="stopWriting()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopWriting</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stopWriting()</pre>
</li>
</ul>
<a id="getOutstandingPackets()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutstandingPackets</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getOutstandingPackets()</pre>
</li>
</ul>
<a id="forceFlushWithBestEffort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceFlushWithBestEffort</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;forceFlushWithBestEffort()</pre>
</li>
</ul>
<a id="onError()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onError</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;onError()</pre>
</li>
</ul>
<a id="onConnect(org.apache.heron.common.network.StatusCode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onConnect</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;onConnect&#8203;(<a href="StatusCode.html" title="enum in org.apache.heron.common.network">StatusCode</a>&nbsp;status)</pre>
</li>
</ul>
<a id="onResponse(org.apache.heron.common.network.StatusCode,java.lang.Object,com.google.protobuf.Message)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onResponse</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;onResponse&#8203;(<a href="StatusCode.html" title="enum in org.apache.heron.common.network">StatusCode</a>&nbsp;status,
java.lang.Object&nbsp;ctx,
com.google.protobuf.Message&nbsp;response)</pre>
</li>
</ul>
<a id="onIncomingMessage(com.google.protobuf.Message)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onIncomingMessage</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;onIncomingMessage&#8203;(com.google.protobuf.Message&nbsp;message)</pre>
</li>
</ul>
<a id="onClose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onClose</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;onClose()</pre>
</li>
</ul>
<a id="getMessageMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageMap</h4>
<pre class="methodSignature">protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;com.google.protobuf.Message.Builder&gt;&nbsp;getMessageMap()</pre>
</li>
</ul>
<a id="getResponseMessageMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResponseMessageMap</h4>
<pre class="methodSignature">protected&nbsp;java.util.Map&lt;<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>,&#8203;com.google.protobuf.Message.Builder&gt;&nbsp;getResponseMessageMap()</pre>
</li>
</ul>
<a id="getContextMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContextMap</h4>
<pre class="methodSignature">protected&nbsp;java.util.Map&lt;<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a>,&#8203;java.lang.Object&gt;&nbsp;getContextMap()</pre>
</li>
</ul>
<a id="getSocketChannelHelper()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSocketChannelHelper</h4>
<pre class="methodSignature">protected&nbsp;<a href="SocketChannelHelper.html" title="class in org.apache.heron.common.network">SocketChannelHelper</a>&nbsp;getSocketChannelHelper()</pre>
</li>
</ul>
<a id="getSocketChannel()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSocketChannel</h4>
<pre class="methodSignature">protected&nbsp;java.nio.channels.SocketChannel&nbsp;getSocketChannel()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>