diff options
Diffstat (limited to 'content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/CommandClient.html')
| -rw-r--r-- | content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/CommandClient.html | 390 |
1 files changed, 390 insertions, 0 deletions
diff --git a/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/CommandClient.html b/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/CommandClient.html new file mode 100644 index 000000000..5ba5ed1a5 --- /dev/null +++ b/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/CommandClient.html @@ -0,0 +1,390 @@ +<!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_352) on Wed Jan 25 17:31:44 CET 2023 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CommandClient (Apache ZooKeeper - Server 3.8.1 API)</title> +<meta name="date" content="2023-01-25"> +<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="CommandClient (Apache ZooKeeper - Server 3.8.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/CommandClient.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>Prev Class</li> +<li><a href="../../../../../org/apache/zookeeper/server/controller/CommandListener.html" title="class in org.apache.zookeeper.server.controller"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/controller/CommandClient.html" target="_top">Frames</a></li> +<li><a href="CommandClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.zookeeper.server.controller</div> +<h2 title="Class CommandClient" class="title">Class CommandClient</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>org.apache.zookeeper.server.controller.CommandClient</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">CommandClient</span> +extends <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></pre> +<div class="block">A convenient helper to send controller command to ControllerService.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/CommandClient.html#CommandClient-java.net.InetSocketAddress-int-">CommandClient</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a> hostAddress, + int requestTimeoutInMs)</code> +<div class="block">Instantiate a client configured to send requests to the specified host address.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/CommandClient.html#CommandClient-int-">CommandClient</a></span>(int localhostPort)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/CommandClient.html#CommandClient-int-int-">CommandClient</a></span>(int localHostPort, + int requestTimeoutInMs)</code> +<div class="block">Instantiate a client configured to send requests to localhost.</div> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/zookeeper/server/controller/CommandClient.html#close--">close</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>org.eclipse.jetty.client.api.ContentResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/CommandClient.html#sendCommand-org.apache.zookeeper.server.controller.ControlCommand.Action-java.lang.String-">sendCommand</a></span>(<a href="../../../../../org/apache/zookeeper/server/controller/ControlCommand.Action.html" title="enum in org.apache.zookeeper.server.controller">ControlCommand.Action</a> action, + <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> commandParameter)</code> +<div class="block">Send a command and optional command parameter to the server and block until receiving + a response.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/CommandClient.html#trySendCommand-org.apache.zookeeper.server.controller.ControlCommand.Action-">trySendCommand</a></span>(<a href="../../../../../org/apache/zookeeper/server/controller/ControlCommand.Action.html" title="enum in org.apache.zookeeper.server.controller">ControlCommand.Action</a> action)</code> +<div class="block">Send a command with no parameters to the server and wait for a response.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/CommandClient.html#trySendCommand-org.apache.zookeeper.server.controller.ControlCommand.Action-java.lang.String-">trySendCommand</a></span>(<a href="../../../../../org/apache/zookeeper/server/controller/ControlCommand.Action.html" title="enum in org.apache.zookeeper.server.controller">ControlCommand.Action</a> action, + <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> commandParameter)</code> +<div class="block">Send a command with an optional command parameter to the server and wait for a response.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CommandClient-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CommandClient</h4> +<pre>public CommandClient(int localHostPort, + int requestTimeoutInMs)</pre> +<div class="block">Instantiate a client configured to send requests to localhost.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>localHostPort</code> - Port that the localhost CommandListener is listening on.</dd> +<dd><code>requestTimeoutInMs</code> - Timeout in ms for synchronous requests to timeout.</dd> +</dl> +</li> +</ul> +<a name="CommandClient-java.net.InetSocketAddress-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CommandClient</h4> +<pre>public CommandClient(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a> hostAddress, + int requestTimeoutInMs)</pre> +<div class="block">Instantiate a client configured to send requests to the specified host address.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>hostAddress</code> - The host address of the listening server.</dd> +<dd><code>requestTimeoutInMs</code> - Timeout in ms for synchronous requests to timeout.</dd> +</dl> +</li> +</ul> +<a name="CommandClient-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CommandClient</h4> +<pre>public CommandClient(int localhostPort)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +</li> +</ul> +<a name="trySendCommand-org.apache.zookeeper.server.controller.ControlCommand.Action-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>trySendCommand</h4> +<pre>public boolean trySendCommand(<a href="../../../../../org/apache/zookeeper/server/controller/ControlCommand.Action.html" title="enum in org.apache.zookeeper.server.controller">ControlCommand.Action</a> action)</pre> +<div class="block">Send a command with no parameters to the server and wait for a response. + Returns true if we received a good (200) response and false otherwise.</div> +</li> +</ul> +<a name="trySendCommand-org.apache.zookeeper.server.controller.ControlCommand.Action-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>trySendCommand</h4> +<pre>public boolean trySendCommand(<a href="../../../../../org/apache/zookeeper/server/controller/ControlCommand.Action.html" title="enum in org.apache.zookeeper.server.controller">ControlCommand.Action</a> action, + <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> commandParameter)</pre> +<div class="block">Send a command with an optional command parameter to the server and wait for a response.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>action</code> - The command Action to send.</dd> +<dd><code>commandParameter</code> - The command parameter, in the form of command/action/parameter.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if we received a good (200) response and false otherwise.</dd> +</dl> +</li> +</ul> +<a name="sendCommand-org.apache.zookeeper.server.controller.ControlCommand.Action-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>sendCommand</h4> +<pre>public org.eclipse.jetty.client.api.ContentResponse sendCommand(<a href="../../../../../org/apache/zookeeper/server/controller/ControlCommand.Action.html" title="enum in org.apache.zookeeper.server.controller">ControlCommand.Action</a> action, + <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> commandParameter) + 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">Send a command and optional command parameter to the server and block until receiving + a response.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>action</code> - The command Action to send.</dd> +<dd><code>commandParameter</code> - The command parameter, in the form of command/action/parameter.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The full response body from the CommandListener server.</dd> +<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></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/CommandClient.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>Prev Class</li> +<li><a href="../../../../../org/apache/zookeeper/server/controller/CommandListener.html" title="class in org.apache.zookeeper.server.controller"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/controller/CommandClient.html" target="_top">Frames</a></li> +<li><a href="CommandClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 © 2008–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |