blob: 57428ed5a11ce8e3ff9706e2cb5660ee5d0db0aa [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>GatewayReceiverMXBean (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="GatewayReceiverMXBean (Apache Geode 1.15.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"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};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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/FixedPartitionAttributesData.html" title="class in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface 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/GatewayReceiverMXBean.html" target="_top">Frames</a></li>
<li><a href="GatewayReceiverMXBean.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 GatewayReceiverMXBean" class="title">Interface GatewayReceiverMXBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">GatewayReceiverMXBean</span></pre>
<div class="block">MBean that provides access to information and management functionality for a
<a href="../../../../org/apache/geode/cache/wan/GatewayReceiver.html" title="interface in org.apache.geode.cache.wan"><code>GatewayReceiver</code></a>.</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></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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getAverageBatchProcessingTime--">getAverageBatchProcessingTime</a></span>()</code>
<div class="block">Returns the average batch processing time (in milliseconds).</div>
</td>
</tr>
<tr id="i1" 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/GatewayReceiverMXBean.html#getBindAddress--">getBindAddress</a></span>()</code>
<div class="block">Returns the bind address on the host.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.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="i3" 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/GatewayReceiverMXBean.html#getConnectedGatewaySenders--">getConnectedGatewaySenders</a></span>()</code>
<div class="block">Returns a list of the host and port information for gateway senders connected to this gateway
receiver.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.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="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getConnectionThreads--">getConnectionThreads</a></span>()</code>
<div class="block">Returns the current number of threads handling a client connection.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getCreateRequestsRate--">getCreateRequestsRate</a></span>()</code>
<div class="block">Returns the rate of create requests received.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getDestroyRequestsRate--">getDestroyRequestsRate</a></span>()</code>
<div class="block">Returns the rate of destroy requests received.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getDuplicateBatchesReceived--">getDuplicateBatchesReceived</a></span>()</code>
<div class="block">Returns the number of duplicate batches which have been received.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getEndPort--">getEndPort</a></span>()</code>
<div class="block">Returns the configured end port.</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/GatewayReceiverMXBean.html#getEventsReceivedRate--">getEventsReceivedRate</a></span>()</code>
<div class="block">Returns the instantaneous rate of events received.</div>
</td>
</tr>
<tr id="i11" 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/GatewayReceiverMXBean.html#getGatewayTransportFilters--">getGatewayTransportFilters</a></span>()</code>
<div class="block">Returns a list of names for the transport filters in use.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getGetRequestAvgLatency--">getGetRequestAvgLatency</a></span>()</code>
<div class="block">Returns the average get request latency.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getGetRequestRate--">getGetRequestRate</a></span>()</code>
<div class="block">Returns the rate of get requests.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.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="i15" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.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="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getMaximumTimeBetweenPings--">getMaximumTimeBetweenPings</a></span>()</code>
<div class="block">Returns the maximum amount of time between client pings.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getNumGateways--">getNumGateways</a></span>()</code>
<div class="block">Returns the number of client virtual machines connected and acting as a gateway.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getOutoforderBatchesReceived--">getOutoforderBatchesReceived</a></span>()</code>
<div class="block">Returns the number of batches which have been received out of order.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getPort--">getPort</a></span>()</code>
<div class="block">Returns the port the receiver is listening on.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getPutRequestAvgLatency--">getPutRequestAvgLatency</a></span>()</code>
<div class="block">Returns the average put request latency.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getPutRequestRate--">getPutRequestRate</a></span>()</code>
<div class="block">Returns the rate of put requests.</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/GatewayReceiverMXBean.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="i23" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getSocketBufferSize--">getSocketBufferSize</a></span>()</code>
<div class="block">Returns the configured buffer size of the socket connection.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getStartPort--">getStartPort</a></span>()</code>
<div class="block">Returns the configured start port.</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/GatewayReceiverMXBean.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="i26" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.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="i27" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getTotalFailedConnectionAttempts--">getTotalFailedConnectionAttempts</a></span>()</code>
<div class="block">Returns the total number of client connection requests that failed.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getTotalReceivedBytes--">getTotalReceivedBytes</a></span>()</code>
<div class="block">Returns the total number of bytes received from clients.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getTotalSentBytes--">getTotalSentBytes</a></span>()</code>
<div class="block">Returns the total number of bytes sent to clients.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#getUpdateRequestsRate--">getUpdateRequestsRate</a></span>()</code>
<div class="block">Returns the rate of update requests received.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#isRunning--">isRunning</a></span>()</code>
<div class="block">Returns whether the receiver is in running state.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#start--">start</a></span>()</code>
<div class="block">Starts the gateway receiver.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html#stop--">stop</a></span>()</code>
<div class="block">Stops the gateway receiver.</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 the receiver is listening on.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the port the receiver is listening 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.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured buffer size of the socket connection</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 the bind address on the host.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the bind address on the host</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.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum amount of time between client pings</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 the receiver is in running state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the receiver is in a running state, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="getEventsReceivedRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventsReceivedRate</h4>
<pre>float&nbsp;getEventsReceivedRate()</pre>
<div class="block">Returns the instantaneous rate of events received.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the instantaneous rate of events received</dd>
</dl>
</li>
</ul>
<a name="getCreateRequestsRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreateRequestsRate</h4>
<pre>float&nbsp;getCreateRequestsRate()</pre>
<div class="block">Returns the rate of create requests received.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of create requests received</dd>
</dl>
</li>
</ul>
<a name="getUpdateRequestsRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpdateRequestsRate</h4>
<pre>float&nbsp;getUpdateRequestsRate()</pre>
<div class="block">Returns the rate of update requests received.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of update requests received</dd>
</dl>
</li>
</ul>
<a name="getDestroyRequestsRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDestroyRequestsRate</h4>
<pre>float&nbsp;getDestroyRequestsRate()</pre>
<div class="block">Returns the rate of destroy requests received.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of destroy requests received</dd>
</dl>
</li>
</ul>
<a name="getDuplicateBatchesReceived--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDuplicateBatchesReceived</h4>
<pre>int&nbsp;getDuplicateBatchesReceived()</pre>
<div class="block">Returns the number of duplicate batches which have been received.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of duplicate batches which have been received</dd>
</dl>
</li>
</ul>
<a name="getOutoforderBatchesReceived--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutoforderBatchesReceived</h4>
<pre>int&nbsp;getOutoforderBatchesReceived()</pre>
<div class="block">Returns the number of batches which have been received out of order.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of batches which have been received out of order</dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>void&nbsp;start()
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">Starts the gateway receiver.</div>
<dl>
<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 starting the receiver</dd>
</dl>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void&nbsp;stop()
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">Stops the gateway receiver.</div>
<dl>
<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 stopping the receiver</dd>
</dl>
</li>
</ul>
<a name="getStartPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartPort</h4>
<pre>int&nbsp;getStartPort()</pre>
<div class="block">Returns the configured start port.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured start port</dd>
</dl>
</li>
</ul>
<a name="getEndPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndPort</h4>
<pre>int&nbsp;getEndPort()</pre>
<div class="block">Returns the configured end port.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured end port</dd>
</dl>
</li>
</ul>
<a name="getGatewayTransportFilters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGatewayTransportFilters</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;getGatewayTransportFilters()</pre>
<div class="block">Returns a list of names for the transport filters in use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of names for the transport filters in use</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="getNumGateways--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumGateways</h4>
<pre>int&nbsp;getNumGateways()</pre>
<div class="block">Returns the number of client virtual machines connected and acting as a gateway.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of client virtual machines connected and acting as a gateway</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="getConnectedGatewaySenders--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectedGatewaySenders</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;getConnectedGatewaySenders()</pre>
<div class="block">Returns a list of the host and port information for gateway senders connected to this gateway
receiver.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of the host and port information for gateway senders connected to this gateway
receiver</dd>
</dl>
</li>
</ul>
<a name="getAverageBatchProcessingTime--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAverageBatchProcessingTime</h4>
<pre>long&nbsp;getAverageBatchProcessingTime()</pre>
<div class="block">Returns the average batch processing time (in milliseconds).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average batch processing time (in milliseconds)</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/FixedPartitionAttributesData.html" title="class in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface 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/GatewayReceiverMXBean.html" target="_top">Frames</a></li>
<li><a href="GatewayReceiverMXBean.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>