blob: 43e3a4edebcac0157a45f3c69ff6c1e21fb76db9 [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 -->
<title>CacheServerMXBean (Apache Geode 1.15.0)</title>
<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="CacheServerMXBean (Apache Geode 1.15.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":38,"i1":38,"i2":38,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":38};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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="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/geode/management/BackupStatus.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/ClientHealthStatus.html" title="class in org.apache.geode.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/management/CacheServerMXBean.html" target="_top">Frames</a></li>
<li><a href="CacheServerMXBean.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.geode.management</div>
<h2 title="Interface CacheServerMXBean" class="title">Interface CacheServerMXBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CacheServerMXBean</span></pre>
<div class="block">MBean that provides access to information and management functionality for a <a href="../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server"><code>CacheServer</code></a>.
<p>
The will be one CacheServerMBean per <a href="../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server"><code>CacheServer</code></a> started in GemFire node.
<p>
ObjectName for this MBean is GemFire:service=CacheServer,port={0},type=Member,member={1}
<table border="1" summary="">
<tr>
<th>Notification Type</th>
<th>Notification Source</th>
<th>Message</th>
</tr>
<tr>
<td>gemfire.distributedsystem.cacheserver.client.joined</td>
<td>CacheServer MBean Name</td>
<td>Client joined with Id &lt;Client ID&gt;</td>
</tr>
<tr>
<td>gemfire.distributedsystem.cacheserver.client.left</td>
<td>CacheServer MBean Name</td>
<td>Client crashed with Id &lt;Client ID&gt;</td>
</tr>
<tr>
<td>gemfire.distributedsystem.cacheserver.client.crashed</td>
<td>CacheServer MBean Name</td>
<td>Client left with Id &lt;Client ID&gt;</td>
</tr>
</table></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 7.0</dd>
</dl>
</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/geode/management/CacheServerMXBean.html#closeAllContinuousQuery-java.lang.String-">closeAllContinuousQuery</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;regionName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.</span></div>
</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#closeContinuousQuery-java.lang.String-">closeContinuousQuery</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;queryName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#executeContinuousQuery-java.lang.String-">executeContinuousQuery</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;queryName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.</span></div>
</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/ServerLoadData.html" title="class in org.apache.geode.management">ServerLoadData</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#fetchLoadProbe--">fetchLoadProbe</a></span>()</code>
<div class="block">Returns the load probe for this CacheServer.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getActiveCQCount--">getActiveCQCount</a></span>()</code>
<div class="block">Returns the number of active (currently executing) CQs.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><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/geode/management/CacheServerMXBean.html#getBindAddress--">getBindAddress</a></span>()</code>
<div class="block">Returns a string representing the IP address or host name that this CacheServer will listen on.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getCapacity--">getCapacity</a></span>()</code>
<div class="block">Returns the capacity (in megabytes) of the client queue.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getClientConnectionCount--">getClientConnectionCount</a></span>()</code>
<div class="block">Returns the number of sockets accepted and used for client to server messaging.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><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/geode/management/CacheServerMXBean.html#getClientIds--">getClientIds</a></span>()</code>
<div class="block">Returns a list of IDs for all connected clients.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getClientNotificationAvgLatency--">getClientNotificationAvgLatency</a></span>()</code>
<div class="block">Returns the average latency for processing client notifications.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getClientNotificationRate--">getClientNotificationRate</a></span>()</code>
<div class="block">Returns the rate of client notifications.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getConnectionLoad--">getConnectionLoad</a></span>()</code>
<div class="block">Returns the load from client to server connections as reported by the load probe installed in
this server.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getConnectionThreads--">getConnectionThreads</a></span>()</code>
<div class="block">Returns the current number of threads handling a client connection.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><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/geode/management/CacheServerMXBean.html#getContinuousQueryList--">getContinuousQueryList</a></span>()</code>
<div class="block">Returns a list of names for all registered CQs.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getCurrentClients--">getCurrentClients</a></span>()</code>
<div class="block">Returns the number of client virtual machines connected.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><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/geode/management/CacheServerMXBean.html#getDiskStoreName--">getDiskStoreName</a></span>()</code>
<div class="block">Returns the name of the disk store that is used for persistence.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><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/geode/management/CacheServerMXBean.html#getEvictionPolicy--">getEvictionPolicy</a></span>()</code>
<div class="block">Returns the eviction policy that is executed when the capacity of the client queue is reached.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getGetRequestAvgLatency--">getGetRequestAvgLatency</a></span>()</code>
<div class="block">Returns the average get request latency.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getGetRequestRate--">getGetRequestRate</a></span>()</code>
<div class="block">Returns the rate of get requests.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><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/geode/management/CacheServerMXBean.html#getHostNameForClients--">getHostNameForClients</a></span>()</code>
<div class="block">Returns the name or IP address to pass to the client as the location where the server is
listening.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getIndexCount--">getIndexCount</a></span>()</code>
<div class="block">Returns the total number of indexes in use by the member.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><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/geode/management/CacheServerMXBean.html#getIndexList--">getIndexList</a></span>()</code>
<div class="block">Returns a list of names for all indexes.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getLoadPerConnection--">getLoadPerConnection</a></span>()</code>
<div class="block">Returns the estimate of how much load is added for each new connection as reported by the load
probe installed in this server.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getLoadPerQueue--">getLoadPerQueue</a></span>()</code>
<div class="block">Returns the estimate of how much load is added for each new queue as reported by the load probe
installed in this server.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getLoadPollInterval--">getLoadPollInterval</a></span>()</code>
<div class="block">Returns the frequency (in milliseconds) to poll the load probe on this CacheServer.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getMaxConnections--">getMaxConnections</a></span>()</code>
<div class="block">Returns the maximum allowed client connections.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getMaximumMessageCount--">getMaximumMessageCount</a></span>()</code>
<div class="block">Returns the maximum number of messages that can be enqueued in a client-queue.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getMaximumTimeBetweenPings--">getMaximumTimeBetweenPings</a></span>()</code>
<div class="block">Returns the maximum amount of time between client pings.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getMaxThreads--">getMaxThreads</a></span>()</code>
<div class="block">Returns the maximum number of threads allowed in this CacheServer to service client requests.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getMessageTimeToLive--">getMessageTimeToLive</a></span>()</code>
<div class="block">Returns the time (in seconds) after which a message in the client queue will expire.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getNumClientNotificationRequests--">getNumClientNotificationRequests</a></span>()</code>
<div class="block">Returns the number of cache client notification requests.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getNumSubscriptions--">getNumSubscriptions</a></span>()</code>
<div class="block">Returns the number of clients who have existing subscriptions.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getPort--">getPort</a></span>()</code>
<div class="block">Returns the port on which this CacheServer listens for clients.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getPutRequestAvgLatency--">getPutRequestAvgLatency</a></span>()</code>
<div class="block">Returns the average put request latency.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getPutRequestRate--">getPutRequestRate</a></span>()</code>
<div class="block">Returns the rate of put requests.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getQueryRequestRate--">getQueryRequestRate</a></span>()</code>
<div class="block">Returns the rate of queries.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getQueueLoad--">getQueueLoad</a></span>()</code>
<div class="block">Returns the load from queues as reported by the load probe installed in this server.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getRegisteredCQCount--">getRegisteredCQCount</a></span>()</code>
<div class="block">Returns the number of registered CQs.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getSocketBufferSize--">getSocketBufferSize</a></span>()</code>
<div class="block">Returns the configured buffer size of the socket connection for this CacheServer.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getThreadQueueSize--">getThreadQueueSize</a></span>()</code>
<div class="block">Returns the current number of connections waiting for a thread to start processing their
message.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getTotalConnectionsTimedOut--">getTotalConnectionsTimedOut</a></span>()</code>
<div class="block">Returns the total number of client connections that timed out and were closed.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getTotalFailedConnectionAttempts--">getTotalFailedConnectionAttempts</a></span>()</code>
<div class="block">Returns the total number of client connection requests that failed.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getTotalIndexMaintenanceTime--">getTotalIndexMaintenanceTime</a></span>()</code>
<div class="block">Returns the total time spent updating indexes due to changes in the data.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getTotalReceivedBytes--">getTotalReceivedBytes</a></span>()</code>
<div class="block">Returns the total number of bytes received from clients.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#getTotalSentBytes--">getTotalSentBytes</a></span>()</code>
<div class="block">Returns the total number of bytes sent to clients.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#isRunning--">isRunning</a></span>()</code>
<div class="block">Returns whether or not this CacheServer is running.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#removeIndex-java.lang.String-">removeIndex</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;indexName)</code>
<div class="block">Remove an index.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/ClientHealthStatus.html" title="class in org.apache.geode.management">ClientHealthStatus</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#showAllClientStats--">showAllClientStats</a></span>()</code>
<div class="block">Returns health and statistic information for all clients.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/ClientQueueDetail.html" title="class in org.apache.geode.management">ClientQueueDetail</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#showClientQueueDetails--">showClientQueueDetails</a></span>()</code>
<div class="block">Shows a list of client with their queue statistics.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/ClientQueueDetail.html" title="class in org.apache.geode.management">ClientQueueDetail</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#showClientQueueDetails-java.lang.String-">showClientQueueDetails</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;clientId)</code>
<div class="block">Shows queue statistics of the given client.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/ClientHealthStatus.html" title="class in org.apache.geode.management">ClientHealthStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#showClientStats-java.lang.String-">showClientStats</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;clientId)</code>
<div class="block">Returns health and statistic information for the give client id.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html#stopContinuousQuery-java.lang.String-">stopContinuousQuery</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;queryName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.</span></div>
</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="getPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPort</h4>
<pre>int&nbsp;getPort()</pre>
<div class="block">Returns the port on which this CacheServer listens for clients.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the port on which this CacheServer listens for clients</dd>
</dl>
</li>
</ul>
<a name="getBindAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBindAddress</h4>
<pre><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;getBindAddress()</pre>
<div class="block">Returns a string representing the IP address or host name that this CacheServer will listen on.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representing the IP address or host name that this CacheServer will listen on</dd>
</dl>
</li>
</ul>
<a name="getSocketBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSocketBufferSize</h4>
<pre>int&nbsp;getSocketBufferSize()</pre>
<div class="block">Returns the configured buffer size of the socket connection for this CacheServer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured buffer size of the socket connection for this CacheServer</dd>
</dl>
</li>
</ul>
<a name="getMaximumTimeBetweenPings--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumTimeBetweenPings</h4>
<pre>int&nbsp;getMaximumTimeBetweenPings()</pre>
<div class="block">Returns the maximum amount of time between client pings. This value is used to determine the
health of client's attached to the server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum amount of time between client pings</dd>
</dl>
</li>
</ul>
<a name="getMaxConnections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxConnections</h4>
<pre>int&nbsp;getMaxConnections()</pre>
<div class="block">Returns the maximum allowed client connections.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum allowed client connections</dd>
</dl>
</li>
</ul>
<a name="getMaxThreads--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxThreads</h4>
<pre>int&nbsp;getMaxThreads()</pre>
<div class="block">Returns the maximum number of threads allowed in this CacheServer to service client requests.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of threads allowed in this CacheServer to service client requests</dd>
</dl>
</li>
</ul>
<a name="getMaximumMessageCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumMessageCount</h4>
<pre>int&nbsp;getMaximumMessageCount()</pre>
<div class="block">Returns the maximum number of messages that can be enqueued in a client-queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of messages that can be enqueued in a client-queue</dd>
</dl>
</li>
</ul>
<a name="getMessageTimeToLive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageTimeToLive</h4>
<pre>int&nbsp;getMessageTimeToLive()</pre>
<div class="block">Returns the time (in seconds) after which a message in the client queue will expire.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time (in seconds) after which a message in the client queue will expire</dd>
</dl>
</li>
</ul>
<a name="getLoadPollInterval--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoadPollInterval</h4>
<pre>long&nbsp;getLoadPollInterval()</pre>
<div class="block">Returns the frequency (in milliseconds) to poll the load probe on this CacheServer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the frequency (in milliseconds) to poll the load probe on this CacheServer</dd>
</dl>
</li>
</ul>
<a name="getHostNameForClients--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHostNameForClients</h4>
<pre><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;getHostNameForClients()</pre>
<div class="block">Returns the name or IP address to pass to the client as the location where the server is
listening. When the server connects to the locator it tells the locator the host and port where
it is listening for client connections. If the host the server uses by default is one that the
client can’t translate into an IP address, the client will have no route to the server’s host
and won’t be able to find the server. For this situation, you must supply the server’s
alternate hostname for the locator to pass to the client.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name or IP address to pass to the client as the location where the server is
listening</dd>
</dl>
</li>
</ul>
<a name="fetchLoadProbe--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchLoadProbe</h4>
<pre><a href="../../../../org/apache/geode/management/ServerLoadData.html" title="class in org.apache.geode.management">ServerLoadData</a>&nbsp;fetchLoadProbe()</pre>
<div class="block">Returns the load probe for this CacheServer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the load probe for this CacheServer</dd>
</dl>
</li>
</ul>
<a name="isRunning--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRunning</h4>
<pre>boolean&nbsp;isRunning()</pre>
<div class="block">Returns whether or not this CacheServer is running.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True of the server is running, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="getCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapacity</h4>
<pre>int&nbsp;getCapacity()</pre>
<div class="block">Returns the capacity (in megabytes) of the client queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the capacity (in megabytes) of the client queue</dd>
</dl>
</li>
</ul>
<a name="getEvictionPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEvictionPolicy</h4>
<pre><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;getEvictionPolicy()</pre>
<div class="block">Returns the eviction policy that is executed when the capacity of the client queue is reached.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the eviction policy that is executed when the capacity of the client queue is reached</dd>
</dl>
</li>
</ul>
<a name="getDiskStoreName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskStoreName</h4>
<pre><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;getDiskStoreName()</pre>
<div class="block">Returns the name of the disk store that is used for persistence.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the disk store that is used for persistence</dd>
</dl>
</li>
</ul>
<a name="getClientConnectionCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientConnectionCount</h4>
<pre>int&nbsp;getClientConnectionCount()</pre>
<div class="block">Returns the number of sockets accepted and used for client to server messaging.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of sockets accepted and used for client to server messaging</dd>
</dl>
</li>
</ul>
<a name="getCurrentClients--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentClients</h4>
<pre>int&nbsp;getCurrentClients()</pre>
<div class="block">Returns the number of client virtual machines connected.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of client virtual machines connected</dd>
</dl>
</li>
</ul>
<a name="getGetRequestAvgLatency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGetRequestAvgLatency</h4>
<pre>long&nbsp;getGetRequestAvgLatency()</pre>
<div class="block">Returns the average get request latency.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average get request latency</dd>
</dl>
</li>
</ul>
<a name="getPutRequestAvgLatency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPutRequestAvgLatency</h4>
<pre>long&nbsp;getPutRequestAvgLatency()</pre>
<div class="block">Returns the average put request latency.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average put request latency</dd>
</dl>
</li>
</ul>
<a name="getTotalConnectionsTimedOut--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalConnectionsTimedOut</h4>
<pre>int&nbsp;getTotalConnectionsTimedOut()</pre>
<div class="block">Returns the total number of client connections that timed out and were closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of client connections that timed out and were closed</dd>
</dl>
</li>
</ul>
<a name="getTotalFailedConnectionAttempts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalFailedConnectionAttempts</h4>
<pre>int&nbsp;getTotalFailedConnectionAttempts()</pre>
<div class="block">Returns the total number of client connection requests that failed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of client connection requests that failed</dd>
</dl>
</li>
</ul>
<a name="getThreadQueueSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThreadQueueSize</h4>
<pre>int&nbsp;getThreadQueueSize()</pre>
<div class="block">Returns the current number of connections waiting for a thread to start processing their
message.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current number of connections waiting for a thread to start processing their
message</dd>
</dl>
</li>
</ul>
<a name="getConnectionThreads--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionThreads</h4>
<pre>int&nbsp;getConnectionThreads()</pre>
<div class="block">Returns the current number of threads handling a client connection.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current number of threads handling a client connection</dd>
</dl>
</li>
</ul>
<a name="getConnectionLoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionLoad</h4>
<pre>double&nbsp;getConnectionLoad()</pre>
<div class="block">Returns the load from client to server connections as reported by the load probe installed in
this server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the load from client to server connections as reported by the load probe installed in
this server</dd>
</dl>
</li>
</ul>
<a name="getLoadPerConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoadPerConnection</h4>
<pre>double&nbsp;getLoadPerConnection()</pre>
<div class="block">Returns the estimate of how much load is added for each new connection as reported by the load
probe installed in this server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the estimate of how much load is added for each new connection as reported by the load
probe installed in this server</dd>
</dl>
</li>
</ul>
<a name="getQueueLoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueLoad</h4>
<pre>double&nbsp;getQueueLoad()</pre>
<div class="block">Returns the load from queues as reported by the load probe installed in this server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the load from queues as reported by the load probe installed in this server</dd>
</dl>
</li>
</ul>
<a name="getLoadPerQueue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoadPerQueue</h4>
<pre>double&nbsp;getLoadPerQueue()</pre>
<div class="block">Returns the estimate of how much load is added for each new queue as reported by the load probe
installed in this server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the estimate of how much load is added for each new queue as reported by the load probe
installed in this server</dd>
</dl>
</li>
</ul>
<a name="getGetRequestRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGetRequestRate</h4>
<pre>float&nbsp;getGetRequestRate()</pre>
<div class="block">Returns the rate of get requests.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of get requests</dd>
</dl>
</li>
</ul>
<a name="getPutRequestRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPutRequestRate</h4>
<pre>float&nbsp;getPutRequestRate()</pre>
<div class="block">Returns the rate of put requests.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of put requests</dd>
</dl>
</li>
</ul>
<a name="getTotalSentBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalSentBytes</h4>
<pre>long&nbsp;getTotalSentBytes()</pre>
<div class="block">Returns the total number of bytes sent to clients.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of bytes sent to clients</dd>
</dl>
</li>
</ul>
<a name="getTotalReceivedBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalReceivedBytes</h4>
<pre>long&nbsp;getTotalReceivedBytes()</pre>
<div class="block">Returns the total number of bytes received from clients.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of bytes received from clients</dd>
</dl>
</li>
</ul>
<a name="getNumClientNotificationRequests--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumClientNotificationRequests</h4>
<pre>int&nbsp;getNumClientNotificationRequests()</pre>
<div class="block">Returns the number of cache client notification requests.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of cache client notification requests</dd>
</dl>
</li>
</ul>
<a name="getClientNotificationAvgLatency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientNotificationAvgLatency</h4>
<pre>long&nbsp;getClientNotificationAvgLatency()</pre>
<div class="block">Returns the average latency for processing client notifications.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average latency for processing client notifications</dd>
</dl>
</li>
</ul>
<a name="getClientNotificationRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientNotificationRate</h4>
<pre>float&nbsp;getClientNotificationRate()</pre>
<div class="block">Returns the rate of client notifications.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of client notifications</dd>
</dl>
</li>
</ul>
<a name="getRegisteredCQCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegisteredCQCount</h4>
<pre>long&nbsp;getRegisteredCQCount()</pre>
<div class="block">Returns the number of registered CQs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of registered CQs</dd>
</dl>
</li>
</ul>
<a name="getActiveCQCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveCQCount</h4>
<pre>long&nbsp;getActiveCQCount()</pre>
<div class="block">Returns the number of active (currently executing) CQs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of active (currently executing) CQs</dd>
</dl>
</li>
</ul>
<a name="getQueryRequestRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryRequestRate</h4>
<pre>float&nbsp;getQueryRequestRate()</pre>
<div class="block">Returns the rate of queries.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of queries</dd>
</dl>
</li>
</ul>
<a name="getIndexCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexCount</h4>
<pre>int&nbsp;getIndexCount()</pre>
<div class="block">Returns the total number of indexes in use by the member.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of indexes in use by the member</dd>
</dl>
</li>
</ul>
<a name="getIndexList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexList</h4>
<pre><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;getIndexList()</pre>
<div class="block">Returns a list of names for all indexes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of names for all indexes</dd>
</dl>
</li>
</ul>
<a name="getTotalIndexMaintenanceTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalIndexMaintenanceTime</h4>
<pre>long&nbsp;getTotalIndexMaintenanceTime()</pre>
<div class="block">Returns the total time spent updating indexes due to changes in the data.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total time spent updating indexes due to changes in the data</dd>
</dl>
</li>
</ul>
<a name="removeIndex-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeIndex</h4>
<pre>void&nbsp;removeIndex(<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;indexName)
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">Remove an index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indexName</code> - Name of the index to be removed.</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> - if an exception is encountered when removing the index</dd>
</dl>
</li>
</ul>
<a name="getContinuousQueryList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContinuousQueryList</h4>
<pre><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;getContinuousQueryList()</pre>
<div class="block">Returns a list of names for all registered CQs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of names for all registered CQs</dd>
</dl>
</li>
</ul>
<a name="executeContinuousQuery-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeContinuousQuery</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
void&nbsp;executeContinuousQuery(<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;queryName)
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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.</span></div>
<div class="block">Execute an ad-hoc CQ on the server</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryName</code> - Name of the CQ to execute.</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> - if an exception is encountered while executing the CQ</dd>
</dl>
</li>
</ul>
<a name="stopContinuousQuery-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopContinuousQuery</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
void&nbsp;stopContinuousQuery(<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;queryName)
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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.</span></div>
<div class="block">Stop (pause) a CQ from executing</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryName</code> - Name of the CQ to stop.</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> - if an exception is encountered while stopping the CQ</dd>
</dl>
</li>
</ul>
<a name="closeAllContinuousQuery-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeAllContinuousQuery</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
void&nbsp;closeAllContinuousQuery(<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;regionName)
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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.</span></div>
<div class="block">Unregister all CQs from a region</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>regionName</code> - Name of the region from which to remove CQs.</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> - if an exception is encountered while unregistering the CQs</dd>
</dl>
</li>
</ul>
<a name="closeContinuousQuery-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeContinuousQuery</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
void&nbsp;closeContinuousQuery(<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;queryName)
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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.</span></div>
<div class="block">Unregister a CQ</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryName</code> - Name of the CQ to unregister.</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> - if an exception is encountered while unregistering the CQ</dd>
</dl>
</li>
</ul>
<a name="getClientIds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientIds</h4>
<pre><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;getClientIds()
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">Returns a list of IDs for all connected clients.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A list of IDs or a length 0 array if no clients are registered.</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> - if an exception is encountered while retrieving the IDs</dd>
</dl>
</li>
</ul>
<a name="showClientStats-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showClientStats</h4>
<pre><a href="../../../../org/apache/geode/management/ClientHealthStatus.html" title="class in org.apache.geode.management">ClientHealthStatus</a>&nbsp;showClientStats(<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;clientId)
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">Returns health and statistic information for the give client id. Some of the information (CPUs,
NumOfCacheListenerCalls, NumOfGets,NumOfMisses, NumOfPuts,NumOfThreads, ProcessCpuTime) only
available for clients which have set a "StatisticsInterval".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientId</code> - ID of the client for which to retrieve information.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>health and statistic information for the given client</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> - if an exception is encountered while retrieving the statistics</dd>
</dl>
</li>
</ul>
<a name="getNumSubscriptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumSubscriptions</h4>
<pre>int&nbsp;getNumSubscriptions()</pre>
<div class="block">Returns the number of clients who have existing subscriptions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of clients who have existing subscriptions</dd>
</dl>
</li>
</ul>
<a name="showAllClientStats--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showAllClientStats</h4>
<pre><a href="../../../../org/apache/geode/management/ClientHealthStatus.html" title="class in org.apache.geode.management">ClientHealthStatus</a>[]&nbsp;showAllClientStats()
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">Returns health and statistic information for all clients. Some of the information (CPUs,
NumOfCacheListenerCalls, NumOfGets,NumOfMisses, NumOfPuts,NumOfThreads, ProcessCpuTime) only
available for clients which have set a "StatisticsInterval".</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>health and statistic information for all clients</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> - if an exception is encountered while retrieving the statistics</dd>
</dl>
</li>
</ul>
<a name="showClientQueueDetails--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showClientQueueDetails</h4>
<pre><a href="../../../../org/apache/geode/management/ClientQueueDetail.html" title="class in org.apache.geode.management">ClientQueueDetail</a>[]&nbsp;showClientQueueDetails()
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">Shows a list of client with their queue statistics. Client queue statistics shown in this
method are the following
eventsEnqueued,eventsRemoved , eventsConflated ,markerEventsConflated , eventsExpired,
eventsRemovedByQrm , eventsTaken , numVoidRemovals</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of ClientQueueDetail</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> - if an exception is encountered while retrieving the statistics</dd>
</dl>
</li>
</ul>
<a name="showClientQueueDetails-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>showClientQueueDetails</h4>
<pre><a href="../../../../org/apache/geode/management/ClientQueueDetail.html" title="class in org.apache.geode.management">ClientQueueDetail</a>&nbsp;showClientQueueDetails(<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;clientId)
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">Shows queue statistics of the given client. Client queue statistics shown in this method are
the following
eventsEnqueued,eventsRemoved , eventsConflated ,markerEventsConflated , eventsExpired,
eventsRemovedByQrm , eventsTaken , numVoidRemovals</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientId</code> - the ID of client which is returned by the attribute ClientIds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>client queue statistics for the given client</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> - if an exception is encountered while retrieving the statistics</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="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/geode/management/BackupStatus.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/ClientHealthStatus.html" title="class in org.apache.geode.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/management/CacheServerMXBean.html" target="_top">Frames</a></li>
<li><a href="CacheServerMXBean.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 ======= -->
</body>
</html>