blob: 08378f8d7bf6934184568e9e4ff349fe5e061d22 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_162) on Thu Feb 01 21:39:07 KST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MessageEnvironment (Coral Project 0.1-SNAPSHOT API)</title>
<meta name="date" content="2018-02-01">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MessageEnvironment (Coral Project 0.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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">
<li><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageContext.html" title="interface in edu.snu.coral.runtime.common.message"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="interface in edu.snu.coral.runtime.common.message"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?edu/snu/coral/runtime/common/message/MessageEnvironment.html" target="_top">Frames</a></li>
<li><a href="MessageEnvironment.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.snu.coral.runtime.common.message</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><a href="../../../../../../edu/snu/coral/runtime/common/message/grpc/GrpcMessageEnvironment.html" title="class in edu.snu.coral.runtime.common.message.grpc">GrpcMessageEnvironment</a>, <a href="../../../../../../edu/snu/coral/runtime/common/message/local/LocalMessageEnvironment.html" title="class in edu.snu.coral.runtime.common.message.local">LocalMessageEnvironment</a>, <a href="../../../../../../edu/snu/coral/runtime/common/message/ncs/NcsMessageEnvironment.html" title="class in edu.snu.coral.runtime.common.message.ncs">NcsMessageEnvironment</a></dd>
</dl>
<hr>
<br>
<pre>@DefaultImplementation(value=<a href="../../../../../../edu/snu/coral/runtime/common/message/ncs/NcsMessageEnvironment.html" title="class in edu.snu.coral.runtime.common.message.ncs">NcsMessageEnvironment.class</a>)
public interface <span class="typeNameLabel">MessageEnvironment</span></pre>
<div class="block">Set up <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="interface in edu.snu.coral.runtime.common.message"><code>MessageListener</code></a>s to handle incoming messages on this node, and connect to remote nodes and return
<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageSender.html" title="interface in edu.snu.coral.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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageEnvironment.html#BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID">BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageEnvironment.html#EXECUTOR_MESSAGE_LISTENER_ID">EXECUTOR_MESSAGE_LISTENER_ID</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageEnvironment.html#MASTER_COMMUNICATION_ID">MASTER_COMMUNICATION_ID</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageEnvironment.html#RUNTIME_MASTER_MESSAGE_LISTENER_ID">RUNTIME_MASTER_MESSAGE_LISTENER_ID</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageSender.html" title="interface in edu.snu.coral.runtime.common.message">MessageSender</a>&lt;T&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageEnvironment.html#asyncConnect-java.lang.String-java.lang.String-">asyncConnect</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;receiverId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;listenerId)</code>
<div class="block">Asynchronously connect to the node called <code>receiverId</code> and return a future of <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageSender.html" title="interface in edu.snu.coral.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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageEnvironment.html#close--">close</a></span>()</code>
<div class="block">Close this message environment.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageEnvironment.html#removeListener-java.lang.String-">removeListener</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;listenerId)</code>
<div class="block">Remove the <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="interface in edu.snu.coral.runtime.common.message"><code>MessageListener</code></a> bound to a specific listener ID.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageEnvironment.html#setupListener-java.lang.String-edu.snu.coral.runtime.common.message.MessageListener-">setupListener</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;listenerId,
<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="interface in edu.snu.coral.runtime.common.message">MessageListener</a>&lt;T&gt;&nbsp;listener)</code>
<div class="block">Set up a <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="interface in edu.snu.coral.runtime.common.message"><code>MessageListener</code></a> with a listener id.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="MASTER_COMMUNICATION_ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MASTER_COMMUNICATION_ID</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MASTER_COMMUNICATION_ID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#edu.snu.coral.runtime.common.message.MessageEnvironment.MASTER_COMMUNICATION_ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RUNTIME_MASTER_MESSAGE_LISTENER_ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RUNTIME_MASTER_MESSAGE_LISTENER_ID</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> RUNTIME_MASTER_MESSAGE_LISTENER_ID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#edu.snu.coral.runtime.common.message.MessageEnvironment.RUNTIME_MASTER_MESSAGE_LISTENER_ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#edu.snu.coral.runtime.common.message.MessageEnvironment.BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EXECUTOR_MESSAGE_LISTENER_ID">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EXECUTOR_MESSAGE_LISTENER_ID</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> EXECUTOR_MESSAGE_LISTENER_ID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#edu.snu.coral.runtime.common.message.MessageEnvironment.EXECUTOR_MESSAGE_LISTENER_ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setupListener-java.lang.String-edu.snu.coral.runtime.common.message.MessageListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupListener</h4>
<pre>&lt;T&gt;&nbsp;void&nbsp;setupListener(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;listenerId,
<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="interface in edu.snu.coral.runtime.common.message">MessageListener</a>&lt;T&gt;&nbsp;listener)</pre>
<div class="block">Set up a <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="interface in edu.snu.coral.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 name="removeListener-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeListener</h4>
<pre>void&nbsp;removeListener(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;listenerId)</pre>
<div class="block">Remove the <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="interface in edu.snu.coral.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 name="asyncConnect-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncConnect</h4>
<pre>&lt;T&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageSender.html" title="interface in edu.snu.coral.runtime.common.message">MessageSender</a>&lt;T&gt;&gt;&nbsp;asyncConnect(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;receiverId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;listenerId)</pre>
<div class="block">Asynchronously connect to the node called <code>receiverId</code> and return a future of <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageSender.html" title="interface in edu.snu.coral.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 name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Close this message environment.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - while closing</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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">
<li><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageContext.html" title="interface in edu.snu.coral.runtime.common.message"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="interface in edu.snu.coral.runtime.common.message"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?edu/snu/coral/runtime/common/message/MessageEnvironment.html" target="_top">Frames</a></li>
<li><a href="MessageEnvironment.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
</body>
</html>