Google Git
Sign in
apache / incubator-nemo-website / 2cb26747de5a4e7e15311533e5fcd936f57e65cf / . / content / apidocs / edu / snu / coral / runtime / common / message / MessageListener.html
blob: 9f0649877f4967282058963906a48294bf4a2119 [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>MessageListener (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="MessageListener (Coral Project 0.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/MessageListener.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/MessageEnvironment.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/MessageParameters.html" title="class 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/MessageListener.html" target="_top">Frames</a></li>
<li><a href="MessageListener.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>Field&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>Field&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 MessageListener" class="title">Interface MessageListener&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - message type</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../edu/snu/coral/runtime/master/BlockManagerMaster.PartitionManagerMasterControlMessageReceiver.html" title="class in edu.snu.coral.runtime.master">BlockManagerMaster.PartitionManagerMasterControlMessageReceiver</a>, <a href="../../../../../../edu/snu/coral/runtime/master/RuntimeMaster.MasterControlMessageReceiver.html" title="class in edu.snu.coral.runtime.master">RuntimeMaster.MasterControlMessageReceiver</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MessageListener&lt;T&gt;</span></pre>
<div class="block">Handles messages from <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageSender.html" title="interface in edu.snu.coral.runtime.common.message"><code>MessageSender</code></a>. Multiple MessageListeners can be setup using <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageEnvironment.html" title="interface in edu.snu.coral.runtime.common.message"><code>MessageEnvironment</code></a>
while they are identified by their unique message type ids.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html#onMessage-T-">onMessage</a></span>(<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="type parameter in MessageListener">T</a>&nbsp;message)</code>
<div class="block">Called back when a message is received.</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/MessageListener.html#onMessageWithContext-T-edu.snu.coral.runtime.common.message.MessageContext-">onMessageWithContext</a></span>(<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="type parameter in MessageListener">T</a>&nbsp;message,
<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageContext.html" title="interface in edu.snu.coral.runtime.common.message">MessageContext</a>&nbsp;messageContext)</code>
<div class="block">Called back when a message is received, and return a response using <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageContext.html" title="interface in edu.snu.coral.runtime.common.message"><code>MessageContext</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="onMessage-java.lang.Object-">
<!-- -->
</a><a name="onMessage-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onMessage</h4>
<pre>void&nbsp;onMessage(<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="type parameter in MessageListener">T</a>&nbsp;message)</pre>
<div class="block">Called back when a message is received.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - a message</dd>
</dl>
</li>
</ul>
<a name="onMessageWithContext-java.lang.Object-edu.snu.coral.runtime.common.message.MessageContext-">
<!-- -->
</a><a name="onMessageWithContext-T-edu.snu.coral.runtime.common.message.MessageContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onMessageWithContext</h4>
<pre>void&nbsp;onMessageWithContext(<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageListener.html" title="type parameter in MessageListener">T</a>&nbsp;message,
<a href="../../../../../../edu/snu/coral/runtime/common/message/MessageContext.html" title="interface in edu.snu.coral.runtime.common.message">MessageContext</a>&nbsp;messageContext)</pre>
<div class="block">Called back when a message is received, and return a response using <a href="../../../../../../edu/snu/coral/runtime/common/message/MessageContext.html" title="interface in edu.snu.coral.runtime.common.message"><code>MessageContext</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - a message</dd>
<dd><code>messageContext</code> - a message context</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/MessageListener.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/MessageEnvironment.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/MessageParameters.html" title="class 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/MessageListener.html" target="_top">Frames</a></li>
<li><a href="MessageListener.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>Field&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>Field&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>