| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 --> |
| <title>MessageEnvironment (Nemo Project 0.4 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-09"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.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.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MessageEnvironment (Nemo Project 0.4 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| 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="class-use/MessageEnvironment.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" 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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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.nemo.runtime.common.message</a></div> |
| <h2 title="Interface MessageEnvironment" class="title">Interface MessageEnvironment</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="grpc/GrpcMessageEnvironment.html" title="class in org.apache.nemo.runtime.common.message.grpc">GrpcMessageEnvironment</a></code>, <code><a href="local/LocalMessageEnvironment.html" title="class in org.apache.nemo.runtime.common.message.local">LocalMessageEnvironment</a></code>, <code><a href="ncs/NcsMessageEnvironment.html" title="class in org.apache.nemo.runtime.common.message.ncs">NcsMessageEnvironment</a></code></dd> |
| </dl> |
| <hr> |
| <pre>@DefaultImplementation(<a href="grpc/GrpcMessageEnvironment.html" title="class in org.apache.nemo.runtime.common.message.grpc">GrpcMessageEnvironment.class</a>) |
| public interface <span class="typeNameLabel">MessageEnvironment</span></pre> |
| <div class="block">Set up <a href="MessageListener.html" title="interface in org.apache.nemo.runtime.common.message"><code>MessageListener</code></a>s to handle incoming messages on this node, and connect to remote nodes and return |
| <a href="MessageSender.html" title="interface in org.apache.nemo.runtime.common.message"><code>MessageSender</code></a>s to send message to them.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <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"> </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>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID">BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EXECUTOR_MESSAGE_LISTENER_ID">EXECUTOR_MESSAGE_LISTENER_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MASTER_COMMUNICATION_ID">MASTER_COMMUNICATION_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PIPE_MANAGER_MASTER_MESSAGE_LISTENER_ID">PIPE_MANAGER_MASTER_MESSAGE_LISTENER_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RUNTIME_MASTER_MESSAGE_LISTENER_ID">RUNTIME_MASTER_MESSAGE_LISTENER_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <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></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><T> java.util.concurrent.Future<<a href="MessageSender.html" title="interface in org.apache.nemo.runtime.common.message">MessageSender</a><T>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asyncConnect(java.lang.String,java.lang.String)">asyncConnect</a></span>​(java.lang.String receiverId, |
| java.lang.String listenerId)</code></th> |
| <td class="colLast"> |
| <div class="block">Asynchronously connect to the node called <code>receiverId</code> and return a future of <a href="MessageSender.html" title="interface in org.apache.nemo.runtime.common.message"><code>MessageSender</code></a> |
| that sends messages to the listener with <code>listenerId</code>.</div> |
| </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="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Close this message environment.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getId()">getId</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="#removeListener(java.lang.String)">removeListener</a></span>​(java.lang.String listenerId)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove the <a href="MessageListener.html" title="interface in org.apache.nemo.runtime.common.message"><code>MessageListener</code></a> bound to a specific listener ID.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setupListener(java.lang.String,org.apache.nemo.runtime.common.message.MessageListener)">setupListener</a></span>​(java.lang.String listenerId, |
| <a href="MessageListener.html" title="interface in org.apache.nemo.runtime.common.message">MessageListener</a><T> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Set up a <a href="MessageListener.html" title="interface in org.apache.nemo.runtime.common.message"><code>MessageListener</code></a> with a listener id.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="MASTER_COMMUNICATION_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MASTER_COMMUNICATION_ID</h4> |
| <pre>static final java.lang.String MASTER_COMMUNICATION_ID</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.nemo.runtime.common.message.MessageEnvironment.MASTER_COMMUNICATION_ID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="RUNTIME_MASTER_MESSAGE_LISTENER_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RUNTIME_MASTER_MESSAGE_LISTENER_ID</h4> |
| <pre>static final java.lang.String RUNTIME_MASTER_MESSAGE_LISTENER_ID</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.nemo.runtime.common.message.MessageEnvironment.RUNTIME_MASTER_MESSAGE_LISTENER_ID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID</h4> |
| <pre>static final java.lang.String BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.nemo.runtime.common.message.MessageEnvironment.BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="PIPE_MANAGER_MASTER_MESSAGE_LISTENER_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PIPE_MANAGER_MASTER_MESSAGE_LISTENER_ID</h4> |
| <pre>static final java.lang.String PIPE_MANAGER_MASTER_MESSAGE_LISTENER_ID</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.nemo.runtime.common.message.MessageEnvironment.PIPE_MANAGER_MASTER_MESSAGE_LISTENER_ID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="EXECUTOR_MESSAGE_LISTENER_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EXECUTOR_MESSAGE_LISTENER_ID</h4> |
| <pre>static final java.lang.String EXECUTOR_MESSAGE_LISTENER_ID</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.nemo.runtime.common.message.MessageEnvironment.EXECUTOR_MESSAGE_LISTENER_ID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setupListener(java.lang.String,org.apache.nemo.runtime.common.message.MessageListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setupListener</h4> |
| <pre class="methodSignature"><T> void setupListener​(java.lang.String listenerId, |
| <a href="MessageListener.html" title="interface in org.apache.nemo.runtime.common.message">MessageListener</a><T> listener)</pre> |
| <div class="block">Set up a <a href="MessageListener.html" title="interface in org.apache.nemo.runtime.common.message"><code>MessageListener</code></a> with a listener id.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type of the message to be sent in the environment</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listenerId</code> - an identifier of the message listener</dd> |
| <dd><code>listener</code> - a message listener</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeListener(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeListener</h4> |
| <pre class="methodSignature">void removeListener​(java.lang.String listenerId)</pre> |
| <div class="block">Remove the <a href="MessageListener.html" title="interface in org.apache.nemo.runtime.common.message"><code>MessageListener</code></a> bound to a specific listener ID.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listenerId</code> - the ID of the listener to remove.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="asyncConnect(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asyncConnect</h4> |
| <pre class="methodSignature"><T> java.util.concurrent.Future<<a href="MessageSender.html" title="interface in org.apache.nemo.runtime.common.message">MessageSender</a><T>> asyncConnect​(java.lang.String receiverId, |
| java.lang.String listenerId)</pre> |
| <div class="block">Asynchronously connect to the node called <code>receiverId</code> and return a future of <a href="MessageSender.html" title="interface in org.apache.nemo.runtime.common.message"><code>MessageSender</code></a> |
| that sends messages to the listener with <code>listenerId</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type of the message to be sent in the environment</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>receiverId</code> - a receiver id</dd> |
| <dd><code>listenerId</code> - an identifier of the message listener</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a message sender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close() |
| throws java.lang.Exception</pre> |
| <div class="block">Close this message environment.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - while closing</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getId()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre class="methodSignature">java.lang.String getId()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>identifier for this node</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="class-use/MessageEnvironment.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" 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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
