Google Git
Sign in
apache / twill / refs/heads/site / . / src / site / resources / apidocs-0.14.0 / org / apache / twill / internal / AbstractZKServiceController.html
blob: e1b3f6f93d9e558125c11a589d3ea923b6e36ec3 [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>AbstractZKServiceController (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="AbstractZKServiceController (Apache Twill 0.14.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":10,"i3":10,"i4":10,"i5":6,"i6":6,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/AbstractZKServiceController.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/AbstractTwillService.html" title="class in org.apache.twill.internal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/twill/internal/ApplicationBundler.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/AbstractZKServiceController.html" target="_top">Frames</a></li>
<li><a href="AbstractZKServiceController.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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="Class AbstractZKServiceController" class="title">Class AbstractZKServiceController</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html" title="class in org.apache.twill.internal">org.apache.twill.internal.AbstractExecutionServiceController</a></li>
<li>
<ul class="inheritance">
<li>org.apache.twill.internal.AbstractZKServiceController</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/twill/internal/AbstractTwillController.html" title="class in org.apache.twill.internal">AbstractTwillController</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractZKServiceController</span>
extends <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html" title="class in org.apache.twill.internal">AbstractExecutionServiceController</a></pre>
<div class="block">An abstract base class for implementing a <a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api"><code>ServiceController</code></a> using ZooKeeper as a means for
communicating with the remote service. This is designed to work in pair with the <a href="../../../../org/apache/twill/internal/AbstractTwillService.html" title="class in org.apache.twill.internal"><code>AbstractTwillService</code></a>.</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>
<!-- =========== 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>protected <a href="../../../../org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#zkClient">zkClient</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#AbstractZKServiceController-org.apache.twill.api.RunId-org.apache.twill.zookeeper.ZKClient-">AbstractZKServiceController</a></span>(<a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api">RunId</a>&nbsp;runId,
<a href="../../../../org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a>&nbsp;zkClient)</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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#doShutDown--">doShutDown</a></span>()</code>
<div class="block">Called during shutdown.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#doStartUp--">doStartUp</a></span>()</code>
<div class="block">Called during startup.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#forceShutDown--">forceShutDown</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/twill/internal/AbstractZKServiceController.html#getInstancePath--">getInstancePath</a></span>()</code>
<div class="block">Returns the zookeeper node path for the ephemeral instance node for this runId.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected com.google.common.util.concurrent.ListenableFuture&lt;com.google.common.util.concurrent.Service.State&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#getStopMessageFuture--">getStopMessageFuture</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#instanceNodeFailed-java.lang.Throwable-">instanceNodeFailed</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;cause)</code>
<div class="block">Called when failed to fetch from live instance node.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#instanceNodeUpdated-org.apache.twill.zookeeper.NodeData-">instanceNodeUpdated</a></span>(<a href="../../../../org/apache/twill/zookeeper/NodeData.html" title="interface in org.apache.twill.zookeeper">NodeData</a>&nbsp;nodeData)</code>
<div class="block">Called when an update on the live instance node is detected.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#sendCommand-org.apache.twill.api.Command-">sendCommand</a></span>(<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a>&nbsp;command)</code>
<div class="block">Sends a user command to the running application.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#sendCommand-java.lang.String-org.apache.twill.api.Command-">sendCommand</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;runnableName,
<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a>&nbsp;command)</code>
<div class="block">Sends a user command to the given runnable of the running application.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected &lt;V&gt;&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#sendMessage-org.apache.twill.internal.state.Message-V-">sendMessage</a></span>(org.apache.twill.internal.state.Message&nbsp;message,
V&nbsp;result)</code>
<div class="block">Sends a <code>Message</code> to the remote service.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#shutDown--">shutDown</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#startUp--">startUp</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html#watchInstanceNode--">watchInstanceNode</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.twill.internal.AbstractExecutionServiceController">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.twill.internal.<a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html" title="class in org.apache.twill.internal">AbstractExecutionServiceController</a></h3>
<code><a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#addListener-com.google.common.util.concurrent.Service.Listener-java.util.concurrent.Executor-">addListener</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#awaitTerminated--">awaitTerminated</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#awaitTerminated-long-java.util.concurrent.TimeUnit-">awaitTerminated</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#executor-com.google.common.util.concurrent.Service.State-">executor</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#getRunId--">getRunId</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#getTerminationStatus--">getTerminationStatus</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#isRunning--">isRunning</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#onRunning-java.lang.Runnable-java.util.concurrent.Executor-">onRunning</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#onTerminated-java.lang.Runnable-java.util.concurrent.Executor-">onTerminated</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#setTerminationStatus-org.apache.twill.api.ServiceController.TerminationStatus-">setTerminationStatus</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#start--">start</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#startAndWait--">startAndWait</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#state--">state</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#stop--">stop</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#stopAndWait--">stopAndWait</a>, <a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#terminate--">terminate</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<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#kill--">kill</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>awaitRunning, awaitRunning, failureCause, startAsync, stopAsync</code></li>
</ul>
</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="zkClient">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>zkClient</h4>
<pre>protected final&nbsp;<a href="../../../../org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a> zkClient</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractZKServiceController-org.apache.twill.api.RunId-org.apache.twill.zookeeper.ZKClient-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractZKServiceController</h4>
<pre>protected&nbsp;AbstractZKServiceController(<a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api">RunId</a>&nbsp;runId,
<a href="../../../../org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a>&nbsp;zkClient)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="sendCommand-org.apache.twill.api.Command-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendCommand</h4>
<pre>public final&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a>&gt;&nbsp;sendCommand(<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a>&nbsp;command)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/ServiceController.html#sendCommand-org.apache.twill.api.Command-">ServiceController</a></code></span></div>
<div class="block">Sends a user command to the running application.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - The command to send.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <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"><code>Future</code></a> that will be completed when the command is successfully processed
by the target application.</dd>
</dl>
</li>
</ul>
<a name="sendCommand-java.lang.String-org.apache.twill.api.Command-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendCommand</h4>
<pre>public final&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a>&gt;&nbsp;sendCommand(<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;runnableName,
<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a>&nbsp;command)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/ServiceController.html#sendCommand-java.lang.String-org.apache.twill.api.Command-">ServiceController</a></code></span></div>
<div class="block">Sends a user command to the given runnable of the running application.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runnableName</code> - Name of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</dd>
<dd><code>command</code> - The command to send.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <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"><code>Future</code></a> that will be completed when the command is successfully processed
by the target runnable.</dd>
</dl>
</li>
</ul>
<a name="startUp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startUp</h4>
<pre>protected final&nbsp;void&nbsp;startUp()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#startUp--">startUp</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html" title="class in org.apache.twill.internal">AbstractExecutionServiceController</a></code></dd>
</dl>
</li>
</ul>
<a name="shutDown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutDown</h4>
<pre>protected final&nbsp;void&nbsp;shutDown()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html#shutDown--">shutDown</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/twill/internal/AbstractExecutionServiceController.html" title="class in org.apache.twill.internal">AbstractExecutionServiceController</a></code></dd>
</dl>
</li>
</ul>
<a name="sendMessage-org.apache.twill.internal.state.Message-java.lang.Object-">
<!-- -->
</a><a name="sendMessage-org.apache.twill.internal.state.Message-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessage</h4>
<pre>protected final&nbsp;&lt;V&gt;&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;V&gt;&nbsp;sendMessage(org.apache.twill.internal.state.Message&nbsp;message,
V&nbsp;result)</pre>
<div class="block">Sends a <code>Message</code> to the remote service. Returns a future that will be completed when the message
has been processed.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - Type of the result.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - The message to send.</dd>
<dd><code>result</code> - Object to set into the future when message is being processed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <code>ListenableFuture</code> that will be completed when the message has been processed.</dd>
</dl>
</li>
</ul>
<a name="getStopMessageFuture--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStopMessageFuture</h4>
<pre>protected final&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;com.google.common.util.concurrent.Service.State&gt;&nbsp;getStopMessageFuture()</pre>
</li>
</ul>
<a name="doStartUp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStartUp</h4>
<pre>protected abstract&nbsp;void&nbsp;doStartUp()</pre>
<div class="block">Called during startup. Executed in the startup thread.</div>
</li>
</ul>
<a name="doShutDown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doShutDown</h4>
<pre>protected abstract&nbsp;void&nbsp;doShutDown()</pre>
<div class="block">Called during shutdown. Executed in the shutdown thread.</div>
</li>
</ul>
<a name="instanceNodeUpdated-org.apache.twill.zookeeper.NodeData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instanceNodeUpdated</h4>
<pre>protected abstract&nbsp;void&nbsp;instanceNodeUpdated(<a href="../../../../org/apache/twill/zookeeper/NodeData.html" title="interface in org.apache.twill.zookeeper">NodeData</a>&nbsp;nodeData)</pre>
<div class="block">Called when an update on the live instance node is detected.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeData</code> - The updated live instance node data or <code>null</code> if there is an error when fetching
the node data.</dd>
</dl>
</li>
</ul>
<a name="instanceNodeFailed-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instanceNodeFailed</h4>
<pre>protected abstract&nbsp;void&nbsp;instanceNodeFailed(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;cause)</pre>
<div class="block">Called when failed to fetch from live instance node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - The cause of failure of <code>null</code> if cause is unknown.</dd>
</dl>
</li>
</ul>
<a name="forceShutDown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceShutDown</h4>
<pre>protected&nbsp;void&nbsp;forceShutDown()</pre>
</li>
</ul>
<a name="watchInstanceNode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>watchInstanceNode</h4>
<pre>protected final&nbsp;void&nbsp;watchInstanceNode()</pre>
</li>
</ul>
<a name="getInstancePath--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInstancePath</h4>
<pre>protected 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>&nbsp;getInstancePath()</pre>
<div class="block">Returns the zookeeper node path for the ephemeral instance node for this runId.</div>
</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/AbstractZKServiceController.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/AbstractTwillService.html" title="class in org.apache.twill.internal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/twill/internal/ApplicationBundler.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/AbstractZKServiceController.html" target="_top">Frames</a></li>
<li><a href="AbstractZKServiceController.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>