| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>HeronServer (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="HeronServer (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":6,"i12":6,"i13":6,"i14":6,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.apache.heron.common.network</a></div> |
| <h2 title="Class HeronServer" class="title">Class HeronServer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.common.network.HeronServer</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="../../ckptmgr/CheckpointManagerServer.html" title="class in org.apache.heron.ckptmgr">CheckpointManagerServer</a></code>, <code><a href="../../metricscachemgr/MetricsCacheManagerServer.html" title="class in org.apache.heron.metricscachemgr">MetricsCacheManagerServer</a></code>, <code><a href="../../metricsmgr/MetricsManagerServer.html" title="class in org.apache.heron.metricsmgr">MetricsManagerServer</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">HeronServer</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">Any Heron Server should implement this abstract class. |
| In particular it should implement |
| a) onConnect method called when a new client connects to us |
| b) onClose method called when a existing client closes |
| c) onRequest method called when we have a new request |
| d) onMessage method called when we have a new message</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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)">HeronServer</a></span>​(<a href="../basics/NIOLooper.html" title="class in org.apache.heron.common.basics">NIOLooper</a> s, |
| java.lang.String host, |
| int port, |
| <a href="HeronSocketOptions.html" title="class in org.apache.heron.common.network">HeronSocketOptions</a> 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>java.nio.channels.ServerSocketChannel</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAcceptChannel()">getAcceptChannel</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.nio.channels.SocketChannel,​<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="#getActiveConnections()">getActiveConnections</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.net.InetSocketAddress</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEndpoint()">getEndpoint</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​com.google.protobuf.Message.Builder></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageMap()">getMessageMap</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​com.google.protobuf.Message.Builder></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestMap()">getRequestMap</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" 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>​(java.nio.channels.SelectableChannel channel)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle a SelectableChannel when it is acceptable</div> |
| </td> |
| </tr> |
| <tr id="i7" 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>​(java.nio.channels.SelectableChannel channel)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle a SelectableChannel when it is connectible</div> |
| </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="#handleError(java.nio.channels.SelectableChannel)">handleError</a></span>​(java.nio.channels.SelectableChannel channel)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle a SelectableChannel when it meets some errors</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="#handleRead(java.nio.channels.SelectableChannel)">handleRead</a></span>​(java.nio.channels.SelectableChannel channel)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle a SelectableChannel when it is readable</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="#handleWrite(java.nio.channels.SelectableChannel)">handleWrite</a></span>​(java.nio.channels.SelectableChannel channel)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle a SelectableChannel when it is writable</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClose(java.nio.channels.SocketChannel)">onClose</a></span>​(java.nio.channels.SocketChannel channel)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onConnect(java.nio.channels.SocketChannel)">onConnect</a></span>​(java.nio.channels.SocketChannel channel)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onMessage(java.nio.channels.SocketChannel,com.google.protobuf.Message)">onMessage</a></span>​(java.nio.channels.SocketChannel channel, |
| com.google.protobuf.Message message)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRequest(org.apache.heron.common.network.REQID,java.nio.channels.SocketChannel,com.google.protobuf.Message)">onRequest</a></span>​(<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a> rid, |
| java.nio.channels.SocketChannel channel, |
| com.google.protobuf.Message request)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" 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>​(com.google.protobuf.Message.Builder builder)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerOnRequest(com.google.protobuf.Message.Builder)">registerOnRequest</a></span>​(com.google.protobuf.Message.Builder builder)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerTimerEvent(java.time.Duration,java.lang.Runnable)">registerTimerEvent</a></span>​(java.time.Duration timer, |
| java.lang.Runnable task)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendMessage(java.nio.channels.SocketChannel,com.google.protobuf.Message)">sendMessage</a></span>​(java.nio.channels.SocketChannel channel, |
| com.google.protobuf.Message message)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendResponse(org.apache.heron.common.network.REQID,java.nio.channels.SocketChannel,com.google.protobuf.Message)">sendResponse</a></span>​(<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a> rid, |
| java.nio.channels.SocketChannel channel, |
| com.google.protobuf.Message response)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th> |
| <td class="colLast"> </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="#stop()">stop</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.heron.common.basics.NIOLooper,java.lang.String,int,org.apache.heron.common.network.HeronSocketOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HeronServer</h4> |
| <pre>public HeronServer​(<a href="../basics/NIOLooper.html" title="class in org.apache.heron.common.basics">NIOLooper</a> s, |
| java.lang.String host, |
| int port, |
| <a href="HeronSocketOptions.html" title="class in org.apache.heron.common.network">HeronSocketOptions</a> 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 server</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="getEndpoint()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpoint</h4> |
| <pre class="methodSignature">public java.net.InetSocketAddress getEndpoint()</pre> |
| </li> |
| </ul> |
| <a id="registerOnMessage(com.google.protobuf.Message.Builder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerOnMessage</h4> |
| <pre class="methodSignature">public void registerOnMessage​(com.google.protobuf.Message.Builder builder)</pre> |
| </li> |
| </ul> |
| <a id="registerOnRequest(com.google.protobuf.Message.Builder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerOnRequest</h4> |
| <pre class="methodSignature">public void registerOnRequest​(com.google.protobuf.Message.Builder builder)</pre> |
| </li> |
| </ul> |
| <a id="start()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre class="methodSignature">public boolean start()</pre> |
| </li> |
| </ul> |
| <a id="stop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre class="methodSignature">public void stop()</pre> |
| </li> |
| </ul> |
| <a id="handleAccept(java.nio.channels.SelectableChannel)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleAccept</h4> |
| <pre class="methodSignature">public void handleAccept​(java.nio.channels.SelectableChannel channel)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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="handleRead(java.nio.channels.SelectableChannel)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleRead</h4> |
| <pre class="methodSignature">public void handleRead​(java.nio.channels.SelectableChannel channel)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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 void handleWrite​(java.nio.channels.SelectableChannel channel)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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 void handleConnect​(java.nio.channels.SelectableChannel channel)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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="handleError(java.nio.channels.SelectableChannel)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleError</h4> |
| <pre class="methodSignature">public void handleError​(java.nio.channels.SelectableChannel channel)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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="sendResponse(org.apache.heron.common.network.REQID,java.nio.channels.SocketChannel,com.google.protobuf.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendResponse</h4> |
| <pre class="methodSignature">public boolean sendResponse​(<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a> rid, |
| java.nio.channels.SocketChannel channel, |
| com.google.protobuf.Message response)</pre> |
| </li> |
| </ul> |
| <a id="sendMessage(java.nio.channels.SocketChannel,com.google.protobuf.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessage</h4> |
| <pre class="methodSignature">public boolean sendMessage​(java.nio.channels.SocketChannel channel, |
| com.google.protobuf.Message message)</pre> |
| </li> |
| </ul> |
| <a id="getNIOLooper()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNIOLooper</h4> |
| <pre class="methodSignature">public <a href="../basics/NIOLooper.html" title="class in org.apache.heron.common.basics">NIOLooper</a> getNIOLooper()</pre> |
| </li> |
| </ul> |
| <a id="registerTimerEvent(java.time.Duration,java.lang.Runnable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerTimerEvent</h4> |
| <pre class="methodSignature">public void registerTimerEvent​(java.time.Duration timer, |
| java.lang.Runnable task)</pre> |
| </li> |
| </ul> |
| <a id="onConnect(java.nio.channels.SocketChannel)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onConnect</h4> |
| <pre class="methodSignature">public abstract void onConnect​(java.nio.channels.SocketChannel channel)</pre> |
| </li> |
| </ul> |
| <a id="onRequest(org.apache.heron.common.network.REQID,java.nio.channels.SocketChannel,com.google.protobuf.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onRequest</h4> |
| <pre class="methodSignature">public abstract void onRequest​(<a href="REQID.html" title="class in org.apache.heron.common.network">REQID</a> rid, |
| java.nio.channels.SocketChannel channel, |
| com.google.protobuf.Message request)</pre> |
| </li> |
| </ul> |
| <a id="onMessage(java.nio.channels.SocketChannel,com.google.protobuf.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onMessage</h4> |
| <pre class="methodSignature">public abstract void onMessage​(java.nio.channels.SocketChannel channel, |
| com.google.protobuf.Message message)</pre> |
| </li> |
| </ul> |
| <a id="onClose(java.nio.channels.SocketChannel)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onClose</h4> |
| <pre class="methodSignature">public abstract void onClose​(java.nio.channels.SocketChannel channel)</pre> |
| </li> |
| </ul> |
| <a id="getMessageMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageMap</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​com.google.protobuf.Message.Builder> getMessageMap()</pre> |
| </li> |
| </ul> |
| <a id="getRequestMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequestMap</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​com.google.protobuf.Message.Builder> getRequestMap()</pre> |
| </li> |
| </ul> |
| <a id="getAcceptChannel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAcceptChannel</h4> |
| <pre class="methodSignature">public java.nio.channels.ServerSocketChannel getAcceptChannel()</pre> |
| </li> |
| </ul> |
| <a id="getActiveConnections()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getActiveConnections</h4> |
| <pre class="methodSignature">public java.util.Map<java.nio.channels.SocketChannel,​<a href="SocketChannelHelper.html" title="class in org.apache.heron.common.network">SocketChannelHelper</a>> getActiveConnections()</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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |