| <!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>GatewaySender (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="GatewaySender (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":38,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6}; |
| 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/cache/wan/GatewayReceiverFactory.html" title="interface in org.apache.geode.cache.wan"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/wan/GatewaySender.html" target="_top">Frames</a></li> |
| <li><a href="GatewaySender.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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.cache.wan</div> |
| <h2 title="Interface GatewaySender" class="title">Interface GatewaySender</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">GatewaySender</span></pre> |
| <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"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan">GatewaySender.OrderPolicy</a></span></code> |
| <div class="block">The order policy.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#CONNECTION_RETRY_INTERVAL">CONNECTION_RETRY_INTERVAL</a></span></code> |
| <div class="block">Retry a connection from sender to receiver after specified time interval (in milliseconds) in |
| case receiver is not up and running.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_ALERT_THRESHOLD">DEFAULT_ALERT_THRESHOLD</a></span></code> |
| <div class="block">The default alert threshold in milliseconds</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_BATCH_CONFLATION">DEFAULT_BATCH_CONFLATION</a></span></code> |
| <div class="block">The default batch conflation</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_BATCH_SIZE">DEFAULT_BATCH_SIZE</a></span></code> |
| <div class="block">The default batch size</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_BATCH_TIME_INTERVAL">DEFAULT_BATCH_TIME_INTERVAL</a></span></code> |
| <div class="block">The default batch time interval in milliseconds</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_DISK_SYNCHRONOUS">DEFAULT_DISK_SYNCHRONOUS</a></span></code> |
| <div class="block">The default value ( true) for writing to disk synchronously in case of persistence.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_DISPATCHER_THREADS">DEFAULT_DISPATCHER_THREADS</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_DISTRIBUTED_SYSTEM_ID">DEFAULT_DISTRIBUTED_SYSTEM_ID</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_ENFORCE_THREADS_CONNECT_SAME_RECEIVER">DEFAULT_ENFORCE_THREADS_CONNECT_SAME_RECEIVER</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_FORWARD_EXPIRATION_DESTROY">DEFAULT_FORWARD_EXPIRATION_DESTROY</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_IS_FOR_INTERNAL_USE">DEFAULT_IS_FOR_INTERNAL_USE</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_IS_PARALLEL">DEFAULT_IS_PARALLEL</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_MANUAL_START">DEFAULT_MANUAL_START</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">- Manual start of senders is deprecated and will be removed in a later release.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_MAXIMUM_QUEUE_MEMORY">DEFAULT_MAXIMUM_QUEUE_MEMORY</a></span></code> |
| <div class="block">The default maximum amount of memory (MB) to allow in the queue before overflowing entries to |
| disk</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_MUST_GROUP_TRANSACTION_EVENTS">DEFAULT_MUST_GROUP_TRANSACTION_EVENTS</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/geode/cache/wan/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan">GatewaySender.OrderPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_ORDER_POLICY">DEFAULT_ORDER_POLICY</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_PARALLELISM_REPLICATED_REGION">DEFAULT_PARALLELISM_REPLICATED_REGION</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_PERSISTENCE_ENABLED">DEFAULT_PERSISTENCE_ENABLED</a></span></code> |
| <div class="block">The default value (false)of whether to persist queue data to disk or not.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_SOCKET_BUFFER_SIZE">DEFAULT_SOCKET_BUFFER_SIZE</a></span></code> |
| <div class="block">The default buffer size for socket buffers from a sending GatewaySender to its receiving |
| <code>GatewayReceiver</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#DEFAULT_SOCKET_READ_TIMEOUT">DEFAULT_SOCKET_READ_TIMEOUT</a></span></code> |
| <div class="block">The default amount of time in milliseconds that a socket read between a sending |
| <code>Gateway</code> and its receiving <code>Gateway</code> will block.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#EARLY_ACK">EARLY_ACK</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#GATEWAY_CONNECTION_IDLE_TIMEOUT">GATEWAY_CONNECTION_IDLE_TIMEOUT</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/cache/wan/GatewaySender.html#GATEWAY_CONNECTION_READ_TIMEOUT_PROPERTY">GATEWAY_CONNECTION_READ_TIMEOUT_PROPERTY</a></span></code> |
| <div class="block">The obsolete socket read timeout java system property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#GATEWAY_SENDER_TIMEOUT">GATEWAY_SENDER_TIMEOUT</a></span></code> |
| <div class="block">Time, in seconds, that we allow before a <code>GatewaySender</code> is considered dead and |
| should be aborted</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#GET_TRANSACTION_EVENTS_FROM_QUEUE_RETRIES">GET_TRANSACTION_EVENTS_FROM_QUEUE_RETRIES</a></span></code> |
| <div class="block">Number of times to retry to get events for a transaction from the gateway sender queue when |
| group-transaction-events is set to true.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#GET_TRANSACTION_EVENTS_FROM_QUEUE_WAIT_TIME_MS">GET_TRANSACTION_EVENTS_FROM_QUEUE_WAIT_TIME_MS</a></span></code> |
| <div class="block">Milliseconds to wait before retrying to get events for a transaction from the |
| gateway sender queue when group-transaction-events is true.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#MINIMUM_SOCKET_READ_TIMEOUT">MINIMUM_SOCKET_READ_TIMEOUT</a></span></code> |
| <div class="block">The default minimum socket read timeout.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#QUEUE_OPLOG_SIZE">QUEUE_OPLOG_SIZE</a></span></code> |
| <div class="block">Size of the oplog file used for the persistent queue in bytes</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#REMOVE_FROM_QUEUE_ON_EXCEPTION">REMOVE_FROM_QUEUE_ON_EXCEPTION</a></span></code> |
| <div class="block">If the System property is set, use it.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#addGatewayEventFilter-org.apache.geode.cache.wan.GatewayEventFilter-">addGatewayEventFilter</a></span>(<a href="../../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a> filter)</code> |
| <div class="block">Adds the provided <code>GatewayEventFilter</code> to this GatewaySender.</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/cache/wan/GatewaySender.html#destroy--">destroy</a></span>()</code> |
| <div class="block">Destroys the GatewaySender.</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/cache/wan/GatewaySender.html#getAlertThreshold--">getAlertThreshold</a></span>()</code> |
| <div class="block">Returns the alert threshold in milliseconds for entries in a GatewaySender's queue.</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/cache/wan/GatewaySender.html#getBatchSize--">getBatchSize</a></span>()</code> |
| <div class="block">Returns the batch size for this GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#getBatchTimeInterval--">getBatchTimeInterval</a></span>()</code> |
| <div class="block">Returns the batch time interval for this GatewaySender.</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/cache/wan/GatewaySender.html#getDiskStoreName--">getDiskStoreName</a></span>()</code> |
| <div class="block">Gets the disk store name for overflow or persistence.</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/cache/wan/GatewaySender.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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#getEnforceThreadsConnectSameReceiver--">getEnforceThreadsConnectSameReceiver</a></span>()</code> |
| <div class="block">Returns enforceThreadsConnectSameReceiver boolean property for this GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#getGatewayEventFilters--">getGatewayEventFilters</a></span>()</code> |
| <div class="block">Returns the list of <code>GatewayEventFilter</code> added to this GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewayEventSubstitutionFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventSubstitutionFilter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#getGatewayEventSubstitutionFilter--">getGatewayEventSubstitutionFilter</a></span>()</code> |
| <div class="block">Returns this <code>GatewaySender's</code> <code>GatewayEventSubstitutionFilter</code>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan">GatewayTransportFilter</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#getGatewayTransportFilters--">getGatewayTransportFilters</a></span>()</code> |
| <div class="block">Returns the list of <code>GatewayTransportFilter</code> added to this GatewaySender.</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/cache/wan/GatewaySender.html#getId--">getId</a></span>()</code> |
| <div class="block">Returns the id of this GatewaySender.</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/cache/wan/GatewaySender.html#getMaximumQueueMemory--">getMaximumQueueMemory</a></span>()</code> |
| <div class="block">Returns the maximum amount of memory (in MB) for a GatewaySender's queue.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#getMaxParallelismForReplicatedRegion--">getMaxParallelismForReplicatedRegion</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan">GatewaySender.OrderPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#getOrderPolicy--">getOrderPolicy</a></span>()</code> |
| <div class="block">Returns the order policy followed while dispatching the events to remote ds.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.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="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.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="i17" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.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> will block.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#isBatchConflationEnabled--">isBatchConflationEnabled</a></span>()</code> |
| <div class="block">Answers whether to enable batch conflation for a GatewaySender 's queue.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#isDiskSynchronous--">isDiskSynchronous</a></span>()</code> |
| <div class="block">Returns isDiskSynchronous boolean property for this GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#isManualStart--">isManualStart</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">- Manual start of senders is deprecated and will be removed in a later release.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#isParallel--">isParallel</a></span>()</code> |
| <div class="block">Returns isParallel boolean property for this GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#isPaused--">isPaused</a></span>()</code> |
| <div class="block">Returns whether or not this GatewaySender is paused.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#isPersistenceEnabled--">isPersistenceEnabled</a></span>()</code> |
| <div class="block">Returns true if persistence is enabled for this GatewaySender, otherwise returns false.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#isRunning--">isRunning</a></span>()</code> |
| <div class="block">Returns whether or not this GatewaySender is running.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#mustGroupTransactionEvents--">mustGroupTransactionEvents</a></span>()</code> |
| <div class="block">Returns groupTransactionEvents boolean property for this GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#pause--">pause</a></span>()</code> |
| <div class="block">Pauses the dispatching of the events from the underlying queue.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#rebalance--">rebalance</a></span>()</code> |
| <div class="block">Rebalances this GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#removeGatewayEventFilter-org.apache.geode.cache.wan.GatewayEventFilter-">removeGatewayEventFilter</a></span>(<a href="../../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a> filter)</code> |
| <div class="block">Removes the provided <code>GatewayEventFilter</code> from this GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#resume--">resume</a></span>()</code> |
| <div class="block">Resumes this paused GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#start--">start</a></span>()</code> |
| <div class="block">Starts this GatewaySender.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#startWithCleanQueue--">startWithCleanQueue</a></span>()</code> |
| <div class="block">Starts this GatewaySender and discards previous queue content.</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/cache/wan/GatewaySender.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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_MANUAL_START"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MANUAL_START</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> |
| static final boolean DEFAULT_MANUAL_START</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">- Manual start of senders is deprecated and will be removed in a later release.</span></div> |
| <div class="block">The default value (false) for manually starting a <code>GatewaySender</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_MANUAL_START">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_DISK_SYNCHRONOUS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_DISK_SYNCHRONOUS</h4> |
| <pre>static final boolean DEFAULT_DISK_SYNCHRONOUS</pre> |
| <div class="block">The default value ( true) for writing to disk synchronously in case of persistence.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_DISK_SYNCHRONOUS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_SOCKET_BUFFER_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_SOCKET_BUFFER_SIZE</h4> |
| <pre>static final int DEFAULT_SOCKET_BUFFER_SIZE</pre> |
| <div class="block">The default buffer size for socket buffers from a sending GatewaySender to its receiving |
| <code>GatewayReceiver</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_SOCKET_BUFFER_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_SOCKET_READ_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_SOCKET_READ_TIMEOUT</h4> |
| <pre>static final int DEFAULT_SOCKET_READ_TIMEOUT</pre> |
| <div class="block">The default amount of time in milliseconds that a socket read between a sending |
| <code>Gateway</code> and its receiving <code>Gateway</code> will block.</div> |
| </li> |
| </ul> |
| <a name="MINIMUM_SOCKET_READ_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MINIMUM_SOCKET_READ_TIMEOUT</h4> |
| <pre>static final int MINIMUM_SOCKET_READ_TIMEOUT</pre> |
| <div class="block">The default minimum socket read timeout.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.MINIMUM_SOCKET_READ_TIMEOUT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUEUE_OPLOG_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUEUE_OPLOG_SIZE</h4> |
| <pre>static final int QUEUE_OPLOG_SIZE</pre> |
| <div class="block">Size of the oplog file used for the persistent queue in bytes</div> |
| </li> |
| </ul> |
| <a name="DEFAULT_PERSISTENCE_ENABLED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_PERSISTENCE_ENABLED</h4> |
| <pre>static final boolean DEFAULT_PERSISTENCE_ENABLED</pre> |
| <div class="block">The default value (false)of whether to persist queue data to disk or not.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_PERSISTENCE_ENABLED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_BATCH_CONFLATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_BATCH_CONFLATION</h4> |
| <pre>static final boolean DEFAULT_BATCH_CONFLATION</pre> |
| <div class="block">The default batch conflation</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_BATCH_CONFLATION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_BATCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_BATCH_SIZE</h4> |
| <pre>static final int DEFAULT_BATCH_SIZE</pre> |
| <div class="block">The default batch size</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_BATCH_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_BATCH_TIME_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_BATCH_TIME_INTERVAL</h4> |
| <pre>static final int DEFAULT_BATCH_TIME_INTERVAL</pre> |
| <div class="block">The default batch time interval in milliseconds</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_BATCH_TIME_INTERVAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_ALERT_THRESHOLD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_ALERT_THRESHOLD</h4> |
| <pre>static final int DEFAULT_ALERT_THRESHOLD</pre> |
| <div class="block">The default alert threshold in milliseconds</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_ALERT_THRESHOLD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_PARALLELISM_REPLICATED_REGION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_PARALLELISM_REPLICATED_REGION</h4> |
| <pre>static final int DEFAULT_PARALLELISM_REPLICATED_REGION</pre> |
| </li> |
| </ul> |
| <a name="DEFAULT_DISTRIBUTED_SYSTEM_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_DISTRIBUTED_SYSTEM_ID</h4> |
| <pre>static final int DEFAULT_DISTRIBUTED_SYSTEM_ID</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_DISTRIBUTED_SYSTEM_ID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_DISPATCHER_THREADS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_DISPATCHER_THREADS</h4> |
| <pre>static final int DEFAULT_DISPATCHER_THREADS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_DISPATCHER_THREADS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_FORWARD_EXPIRATION_DESTROY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_FORWARD_EXPIRATION_DESTROY</h4> |
| <pre>static final boolean DEFAULT_FORWARD_EXPIRATION_DESTROY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_FORWARD_EXPIRATION_DESTROY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_ORDER_POLICY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_ORDER_POLICY</h4> |
| <pre><a href="../../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a> |
| static final <a href="../../../../../org/apache/geode/cache/wan/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan">GatewaySender.OrderPolicy</a> DEFAULT_ORDER_POLICY</pre> |
| </li> |
| </ul> |
| <a name="DEFAULT_MAXIMUM_QUEUE_MEMORY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAXIMUM_QUEUE_MEMORY</h4> |
| <pre>static final int DEFAULT_MAXIMUM_QUEUE_MEMORY</pre> |
| <div class="block">The default maximum amount of memory (MB) to allow in the queue before overflowing entries to |
| disk</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_MAXIMUM_QUEUE_MEMORY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="GATEWAY_SENDER_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GATEWAY_SENDER_TIMEOUT</h4> |
| <pre>static final long GATEWAY_SENDER_TIMEOUT</pre> |
| <div class="block">Time, in seconds, that we allow before a <code>GatewaySender</code> is considered dead and |
| should be aborted</div> |
| </li> |
| </ul> |
| <a name="GATEWAY_CONNECTION_READ_TIMEOUT_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GATEWAY_CONNECTION_READ_TIMEOUT_PROPERTY</h4> |
| <pre>static final <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> GATEWAY_CONNECTION_READ_TIMEOUT_PROPERTY</pre> |
| <div class="block">The obsolete socket read timeout java system property. Since customers have been given this |
| property, it is used to log a warning.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.GATEWAY_CONNECTION_READ_TIMEOUT_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="GATEWAY_CONNECTION_IDLE_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GATEWAY_CONNECTION_IDLE_TIMEOUT</h4> |
| <pre>static final int GATEWAY_CONNECTION_IDLE_TIMEOUT</pre> |
| </li> |
| </ul> |
| <a name="REMOVE_FROM_QUEUE_ON_EXCEPTION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REMOVE_FROM_QUEUE_ON_EXCEPTION</h4> |
| <pre>static final boolean REMOVE_FROM_QUEUE_ON_EXCEPTION</pre> |
| <div class="block">If the System property is set, use it. Otherwise, set default to 'true'.</div> |
| </li> |
| </ul> |
| <a name="EARLY_ACK"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EARLY_ACK</h4> |
| <pre>static final boolean EARLY_ACK</pre> |
| </li> |
| </ul> |
| <a name="DEFAULT_IS_PARALLEL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_IS_PARALLEL</h4> |
| <pre>static final boolean DEFAULT_IS_PARALLEL</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_IS_PARALLEL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_MUST_GROUP_TRANSACTION_EVENTS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MUST_GROUP_TRANSACTION_EVENTS</h4> |
| <pre>static final boolean DEFAULT_MUST_GROUP_TRANSACTION_EVENTS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_MUST_GROUP_TRANSACTION_EVENTS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_IS_FOR_INTERNAL_USE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_IS_FOR_INTERNAL_USE</h4> |
| <pre>static final boolean DEFAULT_IS_FOR_INTERNAL_USE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_IS_FOR_INTERNAL_USE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_ENFORCE_THREADS_CONNECT_SAME_RECEIVER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_ENFORCE_THREADS_CONNECT_SAME_RECEIVER</h4> |
| <pre>static final boolean DEFAULT_ENFORCE_THREADS_CONNECT_SAME_RECEIVER</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewaySender.DEFAULT_ENFORCE_THREADS_CONNECT_SAME_RECEIVER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CONNECTION_RETRY_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONNECTION_RETRY_INTERVAL</h4> |
| <pre>static final int CONNECTION_RETRY_INTERVAL</pre> |
| <div class="block">Retry a connection from sender to receiver after specified time interval (in milliseconds) in |
| case receiver is not up and running. Default is set to 1000 milliseconds i.e. 1 second.</div> |
| </li> |
| </ul> |
| <a name="GET_TRANSACTION_EVENTS_FROM_QUEUE_RETRIES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GET_TRANSACTION_EVENTS_FROM_QUEUE_RETRIES</h4> |
| <pre>static final int GET_TRANSACTION_EVENTS_FROM_QUEUE_RETRIES</pre> |
| <div class="block">Number of times to retry to get events for a transaction from the gateway sender queue when |
| group-transaction-events is set to true. |
| When group-transaction-events is set to true and a batch ready to be sent does not contain |
| all the events for all the transactions to which the events belong, the gateway sender will try |
| to get the missing events of the transactions from the queue to add them to the batch |
| before sending it. |
| If the missing events are not in the queue when the gateway sender tries to get them |
| it will retry for a maximum of times equal to the value set in this parameter before |
| delivering the batch without the missing events and logging an error. |
| Setting this parameter to a very low value could cause that under heavy load and |
| group-transaction-events set to true, batches are sent with incomplete transactions. Setting it |
| to a high value could cause that under heavy load and group-transaction-events set to true, |
| batches are held for some time before being sent.</div> |
| </li> |
| </ul> |
| <a name="GET_TRANSACTION_EVENTS_FROM_QUEUE_WAIT_TIME_MS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>GET_TRANSACTION_EVENTS_FROM_QUEUE_WAIT_TIME_MS</h4> |
| <pre>static final int GET_TRANSACTION_EVENTS_FROM_QUEUE_WAIT_TIME_MS</pre> |
| <div class="block">Milliseconds to wait before retrying to get events for a transaction from the |
| gateway sender queue when group-transaction-events is true.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void 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 startWithCleanQueue()</pre> |
| <div class="block">Starts this GatewaySender and discards 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 stop()</pre> |
| <div class="block">Stops this GatewaySender. The scope of this operation is the VM on which it is invoked. In case |
| the GatewaySender is parallel, the GatewaySender will be stopped on individual node where this |
| API is called. If the GatewaySender is not parallel, then the GatewaySender will stop on this |
| VM and the secondary GatewaySender will become primary and start dispatching events. |
| |
| The GatewaySender will wait for GatewaySender.MAXIMUM_SHUTDOWN_WAIT_TIME seconds before |
| stopping itself. If the system property is set to -1 then it will wait until all the events are |
| dispatched from the queue.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#isParallel--"><code>isParallel()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pause--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pause</h4> |
| <pre>void pause()</pre> |
| <div class="block">Pauses the dispatching of the events from the underlying queue. It should be kept in mind that |
| the events will still be getting queued into the queue. The scope of this operation is the VM |
| on which it is invoked. In case the GatewaySender is parallel, the GatewaySender will be paused |
| on individual node where this API is called and the GatewaySender on other VM's can still |
| dispatch events. In case the GatewaySender is not parallel, and the running GatewaySender on |
| which this API is invoked is not primary then PRIMARY GatewaySender will still continue |
| dispatching events. |
| |
| The batch of events that are in the process of being dispatched are dispatched irrespective of |
| the state of pause operation. We can expect maximum of one batch of events being received at |
| the GatewayReceiver even after the GatewaySenders were paused.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#isParallel--"><code>isParallel()</code></a>, |
| <a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#getBatchSize--"><code>getBatchSize()</code></a>, |
| <a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html#resume--"><code>resume()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resume--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resume</h4> |
| <pre>void 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 rebalance()</pre> |
| <div class="block">Rebalances this GatewaySender.</div> |
| </li> |
| </ul> |
| <a name="isRunning--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRunning</h4> |
| <pre>boolean isRunning()</pre> |
| <div class="block">Returns whether or not this GatewaySender is running.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this GatewaySender is running</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPaused--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPaused</h4> |
| <pre>boolean isPaused()</pre> |
| <div class="block">Returns whether or not this GatewaySender is paused.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this GatewaySender is paused</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addGatewayEventFilter-org.apache.geode.cache.wan.GatewayEventFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addGatewayEventFilter</h4> |
| <pre>void addGatewayEventFilter(<a href="../../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a> filter)</pre> |
| <div class="block">Adds the provided <code>GatewayEventFilter</code> to this GatewaySender.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the <code>GatewayEventFilter</code> to add</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeGatewayEventFilter-org.apache.geode.cache.wan.GatewayEventFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeGatewayEventFilter</h4> |
| <pre>void removeGatewayEventFilter(<a href="../../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a> filter)</pre> |
| <div class="block">Removes the provided <code>GatewayEventFilter</code> from this GatewaySender.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the <code>GatewayEventFilter</code> to remove</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGatewayEventSubstitutionFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGatewayEventSubstitutionFilter</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/wan/GatewayEventSubstitutionFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventSubstitutionFilter</a> getGatewayEventSubstitutionFilter()</pre> |
| <div class="block">Returns this <code>GatewaySender's</code> <code>GatewayEventSubstitutionFilter</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <code>GatewaySender's</code> <code>GatewayEventSubstitutionFilter</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</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> getId()</pre> |
| <div class="block">Returns the id of this GatewaySender.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the id of this GatewaySender.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRemoteDSId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteDSId</h4> |
| <pre>int 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 getSocketBufferSize()</pre> |
| <div class="block">Returns the configured buffer size of the socket connection between this GatewaySender and its |
| receiving <code>GatewayReceiver</code>. The default is 32768 bytes.</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>int 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> will block. The default value is 0 which is |
| interpreted as infinite timeout.</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> will block</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> getDiskStoreName()</pre> |
| <div class="block">Gets the disk store name for overflow or persistence.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>disk store name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumQueueMemory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumQueueMemory</h4> |
| <pre>int getMaximumQueueMemory()</pre> |
| <div class="block">Returns the maximum amount of memory (in MB) for a GatewaySender's queue. The default is 100.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum amount of memory (in MB) for a GatewaySender's queue</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBatchSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBatchSize</h4> |
| <pre>int getBatchSize()</pre> |
| <div class="block">Returns the batch size for this GatewaySender. Default batchSize is 100.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the batch size for this GatewaySender.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBatchTimeInterval--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBatchTimeInterval</h4> |
| <pre>int getBatchTimeInterval()</pre> |
| <div class="block">Returns the batch time interval for this GatewaySender. Default value of batchTimeInterval is |
| 1000.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the batch time interval for this GatewaySender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isBatchConflationEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBatchConflationEnabled</h4> |
| <pre>boolean isBatchConflationEnabled()</pre> |
| <div class="block">Answers whether to enable batch conflation for a GatewaySender 's queue. The default value is |
| false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to enable batch conflation for batches sent from a GatewaySender to its |
| corresponding <code>GatewayReceiver</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPersistenceEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPersistenceEnabled</h4> |
| <pre>boolean isPersistenceEnabled()</pre> |
| <div class="block">Returns true if persistence is enabled for this GatewaySender, otherwise returns false. Default |
| is false if not set explicitly.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if persistence is enabled for this GatewaySender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAlertThreshold--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAlertThreshold</h4> |
| <pre>int getAlertThreshold()</pre> |
| <div class="block">Returns the alert threshold in milliseconds for entries in a GatewaySender's queue. Default |
| value is 0.</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/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a>> getGatewayEventFilters()</pre> |
| <div class="block">Returns the list of <code>GatewayEventFilter</code> added to this GatewaySender.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of <code>GatewayEventFilter</code> 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/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan">GatewayTransportFilter</a>> getGatewayTransportFilters()</pre> |
| <div class="block">Returns the list of <code>GatewayTransportFilter</code> added to this GatewaySender.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of <code>GatewayTransportFilter</code> added to this GatewaySender.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDiskSynchronous--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDiskSynchronous</h4> |
| <pre>boolean isDiskSynchronous()</pre> |
| <div class="block">Returns isDiskSynchronous boolean property for this GatewaySender. Default value is true.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>isDiskSynchronous boolean property for this GatewaySender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isManualStart--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isManualStart</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> |
| boolean isManualStart()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">- Manual start of senders is deprecated and will be removed in a later release.</span></div> |
| <div class="block">Returns the manual start boolean property for this GatewaySender. Default is false i.e. the |
| GatewaySender will automatically start once created.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the manual start boolean property for this GatewaySender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isParallel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isParallel</h4> |
| <pre>boolean isParallel()</pre> |
| <div class="block">Returns isParallel boolean property for this GatewaySender.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>isParallel boolean property for this GatewaySender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="mustGroupTransactionEvents--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mustGroupTransactionEvents</h4> |
| <pre>boolean mustGroupTransactionEvents()</pre> |
| <div class="block">Returns groupTransactionEvents boolean property for this GatewaySender.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>groupTransactionEvents boolean property for this GatewaySender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDispatcherThreads--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDispatcherThreads</h4> |
| <pre>int getDispatcherThreads()</pre> |
| <div class="block">Returns the number of dispatcher threads working for this <code>GatewaySender</code>. Default |
| number of dispatcher threads is 5.</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="../../../../../org/apache/geode/cache/wan/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan">GatewaySender.OrderPolicy</a> getOrderPolicy()</pre> |
| <div class="block">Returns the order policy followed while dispatching the events to remote ds. Order policy is |
| set only when dispatcher threads are > 1. Default value of order policy is KEY.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the order policy followed while dispatching the events to remote ds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxParallelismForReplicatedRegion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxParallelismForReplicatedRegion</h4> |
| <pre>int getMaxParallelismForReplicatedRegion()</pre> |
| </li> |
| </ul> |
| <a name="destroy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>void destroy()</pre> |
| <div class="block">Destroys the GatewaySender. |
| <p> |
| In case of ParallelGatewaySender, the destroy operation does distributed destroy of the Queue |
| Region. In case of SerialGatewaySender, the Queue Region is destroyed locally.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEnforceThreadsConnectSameReceiver--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEnforceThreadsConnectSameReceiver</h4> |
| <pre>boolean getEnforceThreadsConnectSameReceiver()</pre> |
| <div class="block">Returns enforceThreadsConnectSameReceiver boolean property for this GatewaySender.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>enforceThreadsConnectSameReceiver boolean property for this GatewaySender</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/cache/wan/GatewayReceiverFactory.html" title="interface in org.apache.geode.cache.wan"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/wan/GatewaySender.html" target="_top">Frames</a></li> |
| <li><a href="GatewaySender.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |