| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>MetricsManagerClient (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="MetricsManagerClient (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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"; |
| 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><a href="#field.summary">Field</a> | </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.network</a></div> |
| <h2 title="Class MetricsManagerClient" class="title">Class MetricsManagerClient</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../common/network/HeronClient.html" title="class in org.apache.heron.common.network">org.apache.heron.common.network.HeronClient</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.network.MetricsManagerClient</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../common/basics/ISelectHandler.html" title="interface in org.apache.heron.common.basics">ISelectHandler</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">MetricsManagerClient</span> |
| extends <a href="../common/network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a></pre> |
| <div class="block">MetricsClient implements SocketClient and communicate with Metrics Manager, it will: |
| 1. Check whether we got a PhysicalPlanHelper in singletonRegistry, and if we got one we will |
| send the register request; so it will not send registerRequest directly when it is connected |
| 2. Handle relative response for register request |
| 3. It will no need call the onIncomingMessage(), since it will not accept any message</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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.heron.common.network.HeronClient"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.heron.common.network.<a href="../common/network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a></h3> |
| <code><a href="../common/network/HeronClient.html#contextMap">contextMap</a>, <a href="../common/network/HeronClient.html#messageMap">messageMap</a>, <a href="../common/network/HeronClient.html#responseMessageMap">responseMessageMap</a></code></li> |
| </ul> |
| </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"> </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.proto.system.PhysicalPlans.Instance,java.util.List,org.apache.heron.common.network.HeronSocketOptions,org.apache.heron.metrics.GatewayMetrics)">MetricsManagerClient</a></span>​(<a href="../common/basics/NIOLooper.html" title="class in org.apache.heron.common.basics">NIOLooper</a> s, |
| java.lang.String metricsHost, |
| int metricsPort, |
| <a href="../proto/system/PhysicalPlans.Instance.html" title="class in org.apache.heron.proto.system">PhysicalPlans.Instance</a> instance, |
| java.util.List<<a href="../common/basics/Communicator.html" title="class in org.apache.heron.common.basics">Communicator</a><<a href="../proto/system/Metrics.MetricPublisherPublishMessage.html" title="class in org.apache.heron.proto.system">Metrics.MetricPublisherPublishMessage</a>>> outs, |
| <a href="../common/network/HeronSocketOptions.html" title="class in org.apache.heron.common.network">HeronSocketOptions</a> options, |
| <a href="../metrics/GatewayMetrics.html" title="class in org.apache.heron.metrics">GatewayMetrics</a> gatewayMetrics)</code></th> |
| <td class="colLast"> </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="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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClose()">onClose</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onConnect(org.apache.heron.common.network.StatusCode)">onConnect</a></span>​(<a href="../common/network/StatusCode.html" title="enum in org.apache.heron.common.network">StatusCode</a> status)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onError()">onError</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onIncomingMessage(com.google.protobuf.Message)">onIncomingMessage</a></span>​(com.google.protobuf.Message message)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>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>​(<a href="../common/network/StatusCode.html" title="enum in org.apache.heron.common.network">StatusCode</a> status, |
| java.lang.Object ctx, |
| com.google.protobuf.Message response)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendAllMessage()">sendAllMessage</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.common.network.HeronClient"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.heron.common.network.<a href="../common/network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a></h3> |
| <code><a href="../common/network/HeronClient.html#forceFlushWithBestEffort()">forceFlushWithBestEffort</a>, <a href="../common/network/HeronClient.html#getContextMap()">getContextMap</a>, <a href="../common/network/HeronClient.html#getMessageMap()">getMessageMap</a>, <a href="../common/network/HeronClient.html#getNIOLooper()">getNIOLooper</a>, <a href="../common/network/HeronClient.html#getOutstandingPackets()">getOutstandingPackets</a>, <a href="../common/network/HeronClient.html#getResponseMessageMap()">getResponseMessageMap</a>, <a href="../common/network/HeronClient.html#getSocketChannel()">getSocketChannel</a>, <a href="../common/network/HeronClient.html#getSocketChannelHelper()">getSocketChannelHelper</a>, <a href="../common/network/HeronClient.html#handleAccept(java.nio.channels.SelectableChannel)">handleAccept</a>, <a href="../common/network/HeronClient.html#handleConnect(java.nio.channels.SelectableChannel)">handleConnect</a>, <a href="../common/network/HeronClient.html#handleError(java.nio.channels.SelectableChannel)">handleError</a>, <a href="../common/network/HeronClient.html#handlePacket(org.apache.heron.common.network.IncomingPacket)">handlePacket</a>, <a href="../common/network/HeronClient.html#handleRead(java.nio.channels.SelectableChannel)">handleRead</a>, <a href="../common/network/HeronClient.html#handleTimeout(org.apache.heron.common.network.REQID)">handleTimeout</a>, <a href="../common/network/HeronClient.html#handleWrite(java.nio.channels.SelectableChannel)">handleWrite</a>, <a href="../common/network/HeronClient.html#isConnected()">isConnected</a>, <a href="../common/network/HeronClient.html#registerOnMessage(com.google.protobuf.Message.Builder)">registerOnMessage</a>, <a href="../common/network/HeronClient.html#sendMessage(com.google.protobuf.Message)">sendMessage</a>, <a href="../common/network/HeronClient.html#sendRequest(com.google.protobuf.Message,com.google.protobuf.Message.Builder)">sendRequest</a>, <a href="../common/network/HeronClient.html#sendRequest(com.google.protobuf.Message,java.lang.Object,com.google.protobuf.Message.Builder,java.time.Duration)">sendRequest</a>, <a href="../common/network/HeronClient.html#start()">start</a>, <a href="../common/network/HeronClient.html#startReading()">startReading</a>, <a href="../common/network/HeronClient.html#startWriting()">startWriting</a>, <a href="../common/network/HeronClient.html#stop()">stop</a>, <a href="../common/network/HeronClient.html#stopReading()">stopReading</a>, <a href="../common/network/HeronClient.html#stopWriting()">stopWriting</a></code></li> |
| </ul> |
| <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.proto.system.PhysicalPlans.Instance,java.util.List,org.apache.heron.common.network.HeronSocketOptions,org.apache.heron.metrics.GatewayMetrics)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MetricsManagerClient</h4> |
| <pre>public MetricsManagerClient​(<a href="../common/basics/NIOLooper.html" title="class in org.apache.heron.common.basics">NIOLooper</a> s, |
| java.lang.String metricsHost, |
| int metricsPort, |
| <a href="../proto/system/PhysicalPlans.Instance.html" title="class in org.apache.heron.proto.system">PhysicalPlans.Instance</a> instance, |
| java.util.List<<a href="../common/basics/Communicator.html" title="class in org.apache.heron.common.basics">Communicator</a><<a href="../proto/system/Metrics.MetricPublisherPublishMessage.html" title="class in org.apache.heron.proto.system">Metrics.MetricPublisherPublishMessage</a>>> outs, |
| <a href="../common/network/HeronSocketOptions.html" title="class in org.apache.heron.common.network">HeronSocketOptions</a> options, |
| <a href="../metrics/GatewayMetrics.html" title="class in org.apache.heron.metrics">GatewayMetrics</a> gatewayMetrics)</pre> |
| </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="sendAllMessage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendAllMessage</h4> |
| <pre class="methodSignature">public void sendAllMessage()</pre> |
| </li> |
| </ul> |
| <a id="onError()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onError</h4> |
| <pre class="methodSignature">public void onError()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/network/HeronClient.html#onError()">onError</a></code> in class <code><a href="../common/network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a></code></dd> |
| </dl> |
| </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 void onConnect​(<a href="../common/network/StatusCode.html" title="enum in org.apache.heron.common.network">StatusCode</a> status)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/network/HeronClient.html#onConnect(org.apache.heron.common.network.StatusCode)">onConnect</a></code> in class <code><a href="../common/network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a></code></dd> |
| </dl> |
| </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 void onResponse​(<a href="../common/network/StatusCode.html" title="enum in org.apache.heron.common.network">StatusCode</a> status, |
| java.lang.Object ctx, |
| com.google.protobuf.Message response)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/network/HeronClient.html#onResponse(org.apache.heron.common.network.StatusCode,java.lang.Object,com.google.protobuf.Message)">onResponse</a></code> in class <code><a href="../common/network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onIncomingMessage(com.google.protobuf.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onIncomingMessage</h4> |
| <pre class="methodSignature">public void onIncomingMessage​(com.google.protobuf.Message message)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/network/HeronClient.html#onIncomingMessage(com.google.protobuf.Message)">onIncomingMessage</a></code> in class <code><a href="../common/network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onClose()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onClose</h4> |
| <pre class="methodSignature">public void onClose()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/network/HeronClient.html#onClose()">onClose</a></code> in class <code><a href="../common/network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a></code></dd> |
| </dl> |
| </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><a href="#field.summary">Field</a> | </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> |
