Google Git
Sign in
apache / geode-site / fc25d29c7053eb6dc81bcd70f2b22d855a2be473 / . / releases / latest / javadoc / org / apache / geode / management / GatewaySenderMXBean.html
blob: b9986bd9ea0fe26d171a9d0728201339caa5feab [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>GatewaySenderMXBean (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="GatewaySenderMXBean (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,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":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/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/GemFireProperties.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/GatewaySenderMXBean.html" target="_top">Frames</a></li>
<li><a href="GatewaySenderMXBean.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 GatewaySenderMXBean" class="title">Interface GatewaySenderMXBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">GatewaySenderMXBean</span></pre>
<div class="block">MBean that provides access to information and management functionality for a
<a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySender</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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getAlertThreshold--">getAlertThreshold</a></span>()</code>
<div class="block">Returns the alert threshold for entries in a GatewaySender's queue.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getAverageDistributionTimePerBatch--">getAverageDistributionTimePerBatch</a></span>()</code>
<div class="block">Returns the average time taken to send a batch of events.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getBatchesDispatchedRate--">getBatchesDispatchedRate</a></span>()</code>
<div class="block">Returns the average number of batches sent per second.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getBatchSize--">getBatchSize</a></span>()</code>
<div class="block">Returns the size of a batch that gets delivered by the GatewaySender.</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/GatewaySenderMXBean.html#getBatchTimeInterval--">getBatchTimeInterval</a></span>()</code>
<div class="block">Returns the interval between transmissions by the GatewaySender.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getBytesOverflowedToDisk--">getBytesOverflowedToDisk</a></span>()</code>
<div class="block">Returns the number of bytes overflowed to disk for this Sender.</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/GatewaySenderMXBean.html#getDispatcherThreads--">getDispatcherThreads</a></span>()</code>
<div class="block">Returns the number of dispatcher threads working for this <code>GatewaySender</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getEntriesOverflowedToDisk--">getEntriesOverflowedToDisk</a></span>()</code>
<div class="block">Returns the number of entries overflowed to disk for this Sender.</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/GatewaySenderMXBean.html#getEventQueueSize--">getEventQueueSize</a></span>()</code>
<div class="block">Returns the current size of the event queue.</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/GatewaySenderMXBean.html#getEventsExceedingAlertThreshold--">getEventsExceedingAlertThreshold</a></span>()</code>
<div class="block">Returns number of events which have exceeded the configured alert threshold.</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/GatewaySenderMXBean.html#getEventsQueuedRate--">getEventsQueuedRate</a></span>()</code>
<div class="block">Returns the rate of events being queued.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getEventsReceivedRate--">getEventsReceivedRate</a></span>()</code>
<div class="block">Returns the rate of events received per second by this Sender.</div>
</td>
</tr>
<tr id="i12" 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/GatewaySenderMXBean.html#getGatewayEventFilters--">getGatewayEventFilters</a></span>()</code>
<div class="block">Returns a list of <code>GatewayEventFilter</code>s added to this GatewaySender.</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/GatewaySenderMXBean.html#getGatewayReceiver--">getGatewayReceiver</a></span>()</code>
<div class="block">Returns the host and port information of GatewayReceiver to which this gateway sender is
connected.</div>
</td>
</tr>
<tr id="i14" 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/GatewaySenderMXBean.html#getGatewayTransportFilters--">getGatewayTransportFilters</a></span>()</code>
<div class="block">Returns a list of <code>GatewayTransportFilter</code>s added to this GatewaySender.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getLRUEvictionsRate--">getLRUEvictionsRate</a></span>()</code>
<div class="block">Returns the rate of LRU evictions per second by this Sender.</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/GatewaySenderMXBean.html#getMaximumQueueMemory--">getMaximumQueueMemory</a></span>()</code>
<div class="block">Returns the maximum memory after which the data needs to be overflowed to disk.</div>
</td>
</tr>
<tr id="i17" 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/GatewaySenderMXBean.html#getOrderPolicy--">getOrderPolicy</a></span>()</code>
<div class="block">Returns the order policy followed while dispatching the events to remote distributed system.</div>
</td>
</tr>
<tr id="i18" 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/GatewaySenderMXBean.html#getOverflowDiskStoreName--">getOverflowDiskStoreName</a></span>()</code>
<div class="block">Returns the name of the disk store that is used for persistence.</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/GatewaySenderMXBean.html#getRemoteDSId--">getRemoteDSId</a></span>()</code>
<div class="block">Returns the id of the remote <code>GatewayReceiver</code>'s DistributedSystem.</div>
</td>
</tr>
<tr id="i20" 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/GatewaySenderMXBean.html#getSenderId--">getSenderId</a></span>()</code>
<div class="block">Returns the ID of the GatewaySender.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getSocketBufferSize--">getSocketBufferSize</a></span>()</code>
<div class="block">Returns the configured buffer size of the socket connection between this GatewaySender and its
receiving <code>GatewayReceiver</code>.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getSocketReadTimeout--">getSocketReadTimeout</a></span>()</code>
<div class="block">Returns the amount of time (in milliseconds) that a socket read between a sending GatewaySender
and its receiving <code>GatewayReceiver</code> is allowed to block.</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/GatewaySenderMXBean.html#getTotalBatchesDistributed--">getTotalBatchesDistributed</a></span>()</code>
<div class="block">Returns the total number of batches of events that were resent.</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/GatewaySenderMXBean.html#getTotalBatchesRedistributed--">getTotalBatchesRedistributed</a></span>()</code>
<div class="block">Returns the total number of batches of events that were resent.</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/GatewaySenderMXBean.html#getTotalBatchesWithIncompleteTransactions--">getTotalBatchesWithIncompleteTransactions</a></span>()</code>
<div class="block">Returns the total number of batches sent with incomplete transactions.</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/GatewaySenderMXBean.html#getTotalEventsConflated--">getTotalEventsConflated</a></span>()</code>
<div class="block">Returns the number of events received, but not added to the event queue, because the queue
already contains an event with the same key.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#getTotalQueueSizeBytesInUse--">getTotalQueueSizeBytesInUse</a></span>()</code>
<div class="block">Returns the total number of bytes in heap occupied by the event queue.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#isBatchConflationEnabled--">isBatchConflationEnabled</a></span>()</code>
<div class="block">Returns whether batch conflation for the GatewaySender's queue is enabled</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#isConnected--">isConnected</a></span>()</code>
<div class="block">Returns whether this GatewaySender is connected and sending data to a GatewayReceiver.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#isDiskSynchronous--">isDiskSynchronous</a></span>()</code>
<div class="block">Returns whether the isDiskSynchronous property is set for this GatewaySender.</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/GatewaySenderMXBean.html#isManualStart--">isManualStart</a></span>()</code>
<div class="block">Returns whether the GatewaySender is configured for manual start.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#isParallel--">isParallel</a></span>()</code>
<div class="block">Returns whether the isParallel property is set for this GatewaySender.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#isPaused--">isPaused</a></span>()</code>
<div class="block">Returns whether or not this GatewaySender is paused.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#isPersistenceEnabled--">isPersistenceEnabled</a></span>()</code>
<div class="block">Returns whether the GatewaySender is configured to be persistent or non-persistent.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#isPrimary--">isPrimary</a></span>()</code>
<div class="block">Returns whether this GatewaySender is primary or secondary.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#isRunning--">isRunning</a></span>()</code>
<div class="block">Returns whether or not this GatewaySender is running.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#mustGroupTransactionEvents--">mustGroupTransactionEvents</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#pause--">pause</a></span>()</code>
<div class="block">Pauses this GatewaySender.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#rebalance--">rebalance</a></span>()</code>
<div class="block">Rebalances this GatewaySender.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#resume--">resume</a></span>()</code>
<div class="block">Resumes this paused GatewaySender.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#start--">start</a></span>()</code>
<div class="block">Starts this GatewaySender.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#startWithCleanQueue--">startWithCleanQueue</a></span>()</code>
<div class="block">Starts this GatewaySender and cleans previous queue content.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html#stop--">stop</a></span>()</code>
<div class="block">Stops this GatewaySender.</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="getSenderId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSenderId</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;getSenderId()</pre>
<div class="block">Returns the ID of the GatewaySender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ID of the GatewaySender</dd>
</dl>
</li>
</ul>
<a name="getRemoteDSId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteDSId</h4>
<pre>int&nbsp;getRemoteDSId()</pre>
<div class="block">Returns the id of the remote <code>GatewayReceiver</code>'s DistributedSystem.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the id of the remote <code>GatewayReceiver</code>'s DistributedSystem</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 between this GatewaySender and its
receiving <code>GatewayReceiver</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured buffer size of the socket connection between this GatewaySender and its
receiving <code>GatewayReceiver</code></dd>
</dl>
</li>
</ul>
<a name="getSocketReadTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSocketReadTimeout</h4>
<pre>long&nbsp;getSocketReadTimeout()</pre>
<div class="block">Returns the amount of time (in milliseconds) that a socket read between a sending GatewaySender
and its receiving <code>GatewayReceiver</code> is allowed to block.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the amount of time (in milliseconds) that a socket read between a sending GatewaySender
and its receiving <code>GatewayReceiver</code> is allowed to block</dd>
</dl>
</li>
</ul>
<a name="getOverflowDiskStoreName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOverflowDiskStoreName</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;getOverflowDiskStoreName()</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="getMaximumQueueMemory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumQueueMemory</h4>
<pre>int&nbsp;getMaximumQueueMemory()</pre>
<div class="block">Returns the maximum memory after which the data needs to be overflowed to disk.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum memory after which the data needs to be overflowed to disk</dd>
</dl>
</li>
</ul>
<a name="getBatchSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBatchSize</h4>
<pre>int&nbsp;getBatchSize()</pre>
<div class="block">Returns the size of a batch that gets delivered by the GatewaySender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the size of a batch that gets delivered by the GatewaySender</dd>
</dl>
</li>
</ul>
<a name="getBatchTimeInterval--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBatchTimeInterval</h4>
<pre>long&nbsp;getBatchTimeInterval()</pre>
<div class="block">Returns the interval between transmissions by the GatewaySender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the interval between transmissions by the GatewaySender</dd>
</dl>
</li>
</ul>
<a name="isBatchConflationEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBatchConflationEnabled</h4>
<pre>boolean&nbsp;isBatchConflationEnabled()</pre>
<div class="block">Returns whether batch conflation for the GatewaySender's queue is enabled</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if batch conflation is enabled, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="isPersistenceEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPersistenceEnabled</h4>
<pre>boolean&nbsp;isPersistenceEnabled()</pre>
<div class="block">Returns whether the GatewaySender is configured to be persistent or non-persistent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the sender is persistent, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="getAlertThreshold--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlertThreshold</h4>
<pre>int&nbsp;getAlertThreshold()</pre>
<div class="block">Returns the alert threshold for entries in a GatewaySender's queue. The default value is 0
milliseconds in which case no alert will be logged if events are delayed in Queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the alert threshold for entries in a GatewaySender's queue</dd>
</dl>
</li>
</ul>
<a name="getGatewayEventFilters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGatewayEventFilters</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;getGatewayEventFilters()</pre>
<div class="block">Returns a list of <code>GatewayEventFilter</code>s added to this GatewaySender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of <code>GatewayEventFilter</code>s added to this GatewaySender</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 <code>GatewayTransportFilter</code>s added to this GatewaySender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of <code>GatewayTransportFilter</code>s added to this GatewaySender</dd>
</dl>
</li>
</ul>
<a name="isManualStart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isManualStart</h4>
<pre>boolean&nbsp;isManualStart()</pre>
<div class="block">Returns whether the GatewaySender is configured for manual start.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the GatewaySender is configured for manual start, false otherwise.</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 GatewaySender is running.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the GatewaySender is running, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="isPaused--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPaused</h4>
<pre>boolean&nbsp;isPaused()</pre>
<div class="block">Returns whether or not this GatewaySender is paused.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True of the GatewaySender is paused, 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 rate of events received per second by this Sender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of events received per second by this Sender</dd>
</dl>
</li>
</ul>
<a name="getEventsQueuedRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventsQueuedRate</h4>
<pre>float&nbsp;getEventsQueuedRate()</pre>
<div class="block">Returns the rate of events being queued.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of events being queued</dd>
</dl>
</li>
</ul>
<a name="getLRUEvictionsRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLRUEvictionsRate</h4>
<pre>float&nbsp;getLRUEvictionsRate()</pre>
<div class="block">Returns the rate of LRU evictions per second by this Sender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate of LRU evictions per second by this Sender</dd>
</dl>
</li>
</ul>
<a name="getEntriesOverflowedToDisk--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntriesOverflowedToDisk</h4>
<pre>long&nbsp;getEntriesOverflowedToDisk()</pre>
<div class="block">Returns the number of entries overflowed to disk for this Sender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of entries overflowed to disk for this Sender</dd>
</dl>
</li>
</ul>
<a name="getBytesOverflowedToDisk--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytesOverflowedToDisk</h4>
<pre>long&nbsp;getBytesOverflowedToDisk()</pre>
<div class="block">Returns the number of bytes overflowed to disk for this Sender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes overflowed to disk for this Sender</dd>
</dl>
</li>
</ul>
<a name="getEventQueueSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventQueueSize</h4>
<pre>int&nbsp;getEventQueueSize()</pre>
<div class="block">Returns the current size of the event queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current size of the event queue</dd>
</dl>
</li>
</ul>
<a name="getTotalEventsConflated--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalEventsConflated</h4>
<pre>int&nbsp;getTotalEventsConflated()</pre>
<div class="block">Returns the number of events received, but not added to the event queue, because the queue
already contains an event with the same key.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of events received, but not added to the event queue, because the queue
already contains an event with the same key</dd>
</dl>
</li>
</ul>
<a name="getBatchesDispatchedRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBatchesDispatchedRate</h4>
<pre>float&nbsp;getBatchesDispatchedRate()</pre>
<div class="block">Returns the average number of batches sent per second.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average number of batches sent per second</dd>
</dl>
</li>
</ul>
<a name="getAverageDistributionTimePerBatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageDistributionTimePerBatch</h4>
<pre>long&nbsp;getAverageDistributionTimePerBatch()</pre>
<div class="block">Returns the average time taken to send a batch of events.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average time taken to send a batch of events</dd>
</dl>
</li>
</ul>
<a name="getTotalBatchesDistributed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalBatchesDistributed</h4>
<pre>int&nbsp;getTotalBatchesDistributed()</pre>
<div class="block">Returns the total number of batches of events that were resent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of batches of events that were resent</dd>
</dl>
</li>
</ul>
<a name="getTotalBatchesRedistributed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalBatchesRedistributed</h4>
<pre>int&nbsp;getTotalBatchesRedistributed()</pre>
<div class="block">Returns the total number of batches of events that were resent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of batches of events that were resent</dd>
</dl>
</li>
</ul>
<a name="getTotalBatchesWithIncompleteTransactions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalBatchesWithIncompleteTransactions</h4>
<pre>int&nbsp;getTotalBatchesWithIncompleteTransactions()</pre>
<div class="block">Returns the total number of batches sent with incomplete transactions.
Only relevant if group-transaction-events is enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of batches sent with incomplete transactions</dd>
</dl>
</li>
</ul>
<a name="getTotalQueueSizeBytesInUse--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalQueueSizeBytesInUse</h4>
<pre>long&nbsp;getTotalQueueSizeBytesInUse()</pre>
<div class="block">Returns the total number of bytes in heap occupied by the event queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of bytes in heap occupied by the event queue</dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>void&nbsp;start()</pre>
<div class="block">Starts this GatewaySender. Once the GatewaySender is running its configuration cannot be
changed.</div>
</li>
</ul>
<a name="startWithCleanQueue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startWithCleanQueue</h4>
<pre>void&nbsp;startWithCleanQueue()</pre>
<div class="block">Starts this GatewaySender and cleans previous queue content.
Once the GatewaySender is running its configuration cannot be changed.</div>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void&nbsp;stop()</pre>
<div class="block">Stops this GatewaySender.</div>
</li>
</ul>
<a name="pause--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pause</h4>
<pre>void&nbsp;pause()</pre>
<div class="block">Pauses this GatewaySender.</div>
</li>
</ul>
<a name="resume--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resume</h4>
<pre>void&nbsp;resume()</pre>
<div class="block">Resumes this paused GatewaySender.</div>
</li>
</ul>
<a name="rebalance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rebalance</h4>
<pre>void&nbsp;rebalance()</pre>
<div class="block">Rebalances this GatewaySender.</div>
</li>
</ul>
<a name="isPrimary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPrimary</h4>
<pre>boolean&nbsp;isPrimary()</pre>
<div class="block">Returns whether this GatewaySender is primary or secondary.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if this is the primary, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="getDispatcherThreads--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDispatcherThreads</h4>
<pre>int&nbsp;getDispatcherThreads()</pre>
<div class="block">Returns the number of dispatcher threads working for this <code>GatewaySender</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of dispatcher threads working for this <code>GatewaySender</code></dd>
</dl>
</li>
</ul>
<a name="getOrderPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrderPolicy</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;getOrderPolicy()</pre>
<div class="block">Returns the order policy followed while dispatching the events to remote distributed system.
Order policy is only relevant when the number of dispatcher threads is greater than one.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the order policy followed while dispatching the events to remote distributed system</dd>
</dl>
</li>
</ul>
<a name="isDiskSynchronous--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDiskSynchronous</h4>
<pre>boolean&nbsp;isDiskSynchronous()</pre>
<div class="block">Returns whether the isDiskSynchronous property is set for this GatewaySender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the property is set, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="isParallel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isParallel</h4>
<pre>boolean&nbsp;isParallel()</pre>
<div class="block">Returns whether the isParallel property is set for this GatewaySender.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the property is set, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="mustGroupTransactionEvents--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mustGroupTransactionEvents</h4>
<pre>boolean&nbsp;mustGroupTransactionEvents()</pre>
</li>
</ul>
<a name="getGatewayReceiver--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGatewayReceiver</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;getGatewayReceiver()</pre>
<div class="block">Returns the host and port information of GatewayReceiver to which this gateway sender is
connected.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the host and port information of GatewayReceiver to which this gateway sender is
connected</dd>
</dl>
</li>
</ul>
<a name="isConnected--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnected</h4>
<pre>boolean&nbsp;isConnected()</pre>
<div class="block">Returns whether this GatewaySender is connected and sending data to a GatewayReceiver.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this GatewaySender is connected and sending data to a GatewayReceiver</dd>
</dl>
</li>
</ul>
<a name="getEventsExceedingAlertThreshold--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getEventsExceedingAlertThreshold</h4>
<pre>int&nbsp;getEventsExceedingAlertThreshold()</pre>
<div class="block">Returns number of events which have exceeded the configured alert threshold.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of events which have exceeded the configured alert threshold</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/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/GemFireProperties.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/GatewaySenderMXBean.html" target="_top">Frames</a></li>
<li><a href="GatewaySenderMXBean.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>