Google Git
Sign in
apache / twill / refs/heads/site / . / src / site / resources / apidocs-0.14.0 / org / apache / twill / internal / TwillContainerController.html
blob: 7b81ac0d74d261141b4b4340ff8cdcc6d287086b [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_221) on Wed Jan 29 15:38:00 PST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TwillContainerController (Apache Twill 0.14.0 API)</title>
<meta name="date" content="2020-01-29">
<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="TwillContainerController (Apache Twill 0.14.0 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/TwillContainerController.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="../../../../org/apache/twill/internal/SingleRunnableApplication.html" title="class in org.apache.twill.internal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/twill/internal/TwillContainerLauncher.html" title="class in org.apache.twill.internal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/internal/TwillContainerController.html" target="_top">Frames</a></li>
<li><a href="TwillContainerController.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">org.apache.twill.internal</div>
<h2 title="Interface TwillContainerController" class="title">Interface TwillContainerController</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>com.google.common.util.concurrent.Service, <a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">TwillContainerController</span>
extends <a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a>, com.google.common.util.concurrent.Service</pre>
<div class="block">A <a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api"><code>ServiceController</code></a> that allows sending a message directly. Internal use only.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.twill.api.ServiceController">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.twill.api.<a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></h3>
<code><a href="../../../../org/apache/twill/api/ServiceController.TerminationStatus.html" title="enum in org.apache.twill.api">ServiceController.TerminationStatus</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.google.common.util.concurrent.Service">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.google.common.util.concurrent.Service</h3>
<code>com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State</code></li>
</ul>
</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/TwillContainerController.html#completed-int-">completed</a></span>(int&nbsp;exitStatus)</code>
<div class="block">Calls to indicated that the container that this controller is associated with is completed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/TwillContainerController.html#getInstanceId--">getInstanceId</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/twill/internal/ContainerLiveNodeData.html" title="class in org.apache.twill.internal">ContainerLiveNodeData</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/TwillContainerController.html#getLiveNodeData--">getLiveNodeData</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;org.apache.twill.internal.state.Message&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/TwillContainerController.html#sendMessage-org.apache.twill.internal.state.Message-">sendMessage</a></span>(org.apache.twill.internal.state.Message&nbsp;message)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.twill.api.ServiceController">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.twill.api.<a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></h3>
<code><a href="../../../../org/apache/twill/api/ServiceController.html#awaitTerminated--">awaitTerminated</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#awaitTerminated-long-java.util.concurrent.TimeUnit-">awaitTerminated</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#getRunId--">getRunId</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#getTerminationStatus--">getTerminationStatus</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#kill--">kill</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#onRunning-java.lang.Runnable-java.util.concurrent.Executor-">onRunning</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#onTerminated-java.lang.Runnable-java.util.concurrent.Executor-">onTerminated</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#sendCommand-org.apache.twill.api.Command-">sendCommand</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#sendCommand-java.lang.String-org.apache.twill.api.Command-">sendCommand</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#terminate--">terminate</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.google.common.util.concurrent.Service">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.google.common.util.concurrent.Service</h3>
<code>addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, start, startAndWait, startAsync, state, stop, stopAndWait, stopAsync</code></li>
</ul>
</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="sendMessage-org.apache.twill.internal.state.Message-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessage</h4>
<pre>com.google.common.util.concurrent.ListenableFuture&lt;org.apache.twill.internal.state.Message&gt;&nbsp;sendMessage(org.apache.twill.internal.state.Message&nbsp;message)</pre>
</li>
</ul>
<a name="completed-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completed</h4>
<pre>void&nbsp;completed(int&nbsp;exitStatus)</pre>
<div class="block">Calls to indicated that the container that this controller is associated with is completed.
Any resources it hold will be releases and all pending futures will be cancelled.</div>
</li>
</ul>
<a name="getLiveNodeData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLiveNodeData</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="../../../../org/apache/twill/internal/ContainerLiveNodeData.html" title="class in org.apache.twill.internal">ContainerLiveNodeData</a>&nbsp;getLiveNodeData()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the container's live node data.</dd>
</dl>
</li>
</ul>
<a name="getInstanceId--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInstanceId</h4>
<pre>int&nbsp;getInstanceId()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the instance ID of the runnable that running in the container controlled by this controller.</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/TwillContainerController.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="../../../../org/apache/twill/internal/SingleRunnableApplication.html" title="class in org.apache.twill.internal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/twill/internal/TwillContainerLauncher.html" title="class in org.apache.twill.internal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/internal/TwillContainerController.html" target="_top">Frames</a></li>
<li><a href="TwillContainerController.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; 2013-2020 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>