| <!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>GatewayReceiver (Apache Geode 1.15.1)</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="GatewayReceiver (Apache Geode 1.15.1)"; |
| } |
| } |
| 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}; |
| 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/cache/wan/GatewayQueueEvent.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/GatewayReceiverFactory.html" title="interface 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/GatewayReceiver.html" target="_top">Frames</a></li> |
| <li><a href="GatewayReceiver.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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 GatewayReceiver" class="title">Interface GatewayReceiver</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">GatewayReceiver</span></pre> |
| <div class="block">A GatewayReceiver that receives the events from a <code>GatewaySender</code>. GatewayReceiver is |
| used in conjunction with a <a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySender</code></a> to connect two distributed-systems. This |
| GatewayReceiver will receive all the events originating in distributed-systems that has a |
| <code>GatewaySender</code> connected to this distributed-system.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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 boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#APPLY_RETRIES">APPLY_RETRIES</a></span></code> |
| <div class="block">If the batch already seen by this receiver, arrives again then whether it is to be re-applied |
| or not is decided by this attribute.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/GatewayReceiver.html#DEFAULT_BIND_ADDRESS">DEFAULT_BIND_ADDRESS</a></span></code> |
| <div class="block">The default ip address or host name that the receiver's socket will listen on for client |
| connections.</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/GatewayReceiver.html#DEFAULT_END_PORT">DEFAULT_END_PORT</a></span></code> |
| <div class="block">Default end value of the port range from which the <code>GatewayReceiver</code>'s port will be |
| chosen</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/GatewayReceiver.html#DEFAULT_HOSTNAME_FOR_SENDERS">DEFAULT_HOSTNAME_FOR_SENDERS</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/GatewayReceiver.html#DEFAULT_MANUAL_START">DEFAULT_MANUAL_START</a></span></code> |
| <div class="block">The default value for manually starting a <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/GatewayReceiver.html#DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS">DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS</a></span></code> |
| <div class="block">The default maximum amount of time between client pings.</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/GatewayReceiver.html#DEFAULT_SOCKET_BUFFER_SIZE">DEFAULT_SOCKET_BUFFER_SIZE</a></span></code> |
| <div class="block">The default buffer size for socket buffers for the <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/GatewayReceiver.html#DEFAULT_START_PORT">DEFAULT_START_PORT</a></span></code> |
| <div class="block">Default start value of the port range from which the <code>GatewayReceiver</code>'s port will |
| be chosen</div> |
| </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/GatewayReceiver.html#RECEIVER_GROUP">RECEIVER_GROUP</a></span></code> </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></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/GatewayReceiver.html#destroy--">destroy</a></span>()</code> |
| <div class="block">Destroys this <code>GatewayReceiver</code>and removes the <code>GatewayReceiverMBean</code> |
| associated with this <code>GatewayReceiver</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#getBindAddress--">getBindAddress</a></span>()</code> |
| <div class="block">Returns a string representing the ip address or host name that this server will listen on.</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/GatewayReceiver.html#getEndPort--">getEndPort</a></span>()</code> |
| <div class="block">Returns end value of the port range from which the <code>GatewayReceiver</code>'s port will be |
| chosen.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <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/GatewayReceiver.html#getGatewayTransportFilters--">getGatewayTransportFilters</a></span>()</code> |
| <div class="block">Returns the list of <code>GatewayTransportFilter</code> added to this GatewayReceiver.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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/cache/wan/GatewayReceiver.html#getHost--">getHost</a></span>()</code> |
| <div class="block">Returns a string representing the ip address or host name that server locators will tell |
| clients (<code>GatewaySender</code>s in this case) that this receiver is listening on.</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/GatewayReceiver.html#getHostnameForSenders--">getHostnameForSenders</a></span>()</code> |
| <div class="block">Returns the hostname configured by <a href="../../../../../org/apache/geode/cache/wan/GatewayReceiverFactory.html#setHostnameForSenders-java.lang.String-"><code>GatewayReceiverFactory.setHostnameForSenders(String)</code></a></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/GatewayReceiver.html#getMaximumTimeBetweenPings--">getMaximumTimeBetweenPings</a></span>()</code> |
| <div class="block">Returns the maximum amount of time between client pings.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#getPort--">getPort</a></span>()</code> |
| <div class="block">Returns the port on which this <code>GatewayReceiver</code> listens for clients.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server">CacheServer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#getServer--">getServer</a></span>()</code> |
| <div class="block">Return the underlying Cacheserver</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/cache/wan/GatewayReceiver.html#getSocketBufferSize--">getSocketBufferSize</a></span>()</code> |
| <div class="block">Returns the configured buffer size of the socket connection for this |
| <code>GatewayReceiver</code>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#getStartPort--">getStartPort</a></span>()</code> |
| <div class="block">Returns start value of the port range from which the <code>GatewayReceiver</code>'s port will |
| be chosen.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#isManualStart--">isManualStart</a></span>()</code> |
| <div class="block">Returns the manual start boolean property for this GatewayReceiver.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#isRunning--">isRunning</a></span>()</code> |
| <div class="block">Returns whether or not this receiver is running</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#start--">start</a></span>()</code> |
| <div class="block">Starts this receiver.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#stop--">stop</a></span>()</code> |
| <div class="block">Stops this receiver.</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="RECEIVER_GROUP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RECEIVER_GROUP</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> RECEIVER_GROUP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewayReceiver.RECEIVER_GROUP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS</h4> |
| <pre>static final int DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS</pre> |
| <div class="block">The default maximum amount of time between client pings. This value is used by the |
| <code>ClientHealthMonitor</code> to determine the health of this <code>GatewayReceiver</code>'s |
| clients.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewayReceiver.DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_START_PORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_START_PORT</h4> |
| <pre>static final int DEFAULT_START_PORT</pre> |
| <div class="block">Default start value of the port range from which the <code>GatewayReceiver</code>'s port will |
| be chosen</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewayReceiver.DEFAULT_START_PORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_END_PORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_END_PORT</h4> |
| <pre>static final int DEFAULT_END_PORT</pre> |
| <div class="block">Default end value of the port range from which the <code>GatewayReceiver</code>'s port will be |
| chosen</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewayReceiver.DEFAULT_END_PORT">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 for the <code>GatewayReceiver</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewayReceiver.DEFAULT_SOCKET_BUFFER_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_BIND_ADDRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_BIND_ADDRESS</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> DEFAULT_BIND_ADDRESS</pre> |
| <div class="block">The default ip address or host name that the receiver's socket will listen on for client |
| connections. The current default is an empty string.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewayReceiver.DEFAULT_BIND_ADDRESS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_HOSTNAME_FOR_SENDERS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_HOSTNAME_FOR_SENDERS</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> DEFAULT_HOSTNAME_FOR_SENDERS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewayReceiver.DEFAULT_HOSTNAME_FOR_SENDERS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_MANUAL_START"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MANUAL_START</h4> |
| <pre>static final boolean DEFAULT_MANUAL_START</pre> |
| <div class="block">The default value for manually starting a <code>GatewayReceiver</code>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 8.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.wan.GatewayReceiver.DEFAULT_MANUAL_START">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="APPLY_RETRIES"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>APPLY_RETRIES</h4> |
| <pre>static final boolean APPLY_RETRIES</pre> |
| <div class="block">If the batch already seen by this receiver, arrives again then whether it is to be re-applied |
| or not is decided by this attribute.</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() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Starts this receiver. Once the receiver is running, its configuration cannot be changed.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an error occurs while starting the receiver</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>void stop()</pre> |
| <div class="block">Stops this receiver. Note that the <code>GatewayReceiver</code> can be reconfigured and |
| restarted if desired.</div> |
| </li> |
| </ul> |
| <a name="destroy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>void destroy()</pre> |
| <div class="block">Destroys this <code>GatewayReceiver</code>and removes the <code>GatewayReceiverMBean</code> |
| associated with this <code>GatewayReceiver</code>. This method does not remove |
| the <code>GatewayReceiver</code> from cluster configuration. |
| The <a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#stop--"><code>stop</code></a> method should be called before calling destroy}</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.geode.internal.cache.wan.GatewayReceiverException</code> - if <code>GatewayReceiver</code> has not been stopped before |
| calling destroy</dd> |
| </dl> |
| </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 receiver is running</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this receiver is running</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 GatewayReceiver.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of <code>GatewayTransportFilter</code> added to this GatewayReceiver.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumTimeBetweenPings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumTimeBetweenPings</h4> |
| <pre>int getMaximumTimeBetweenPings()</pre> |
| <div class="block">Returns the maximum amount of time between client pings. This value is used by the |
| <code>ClientHealthMonitor</code> to determine the health of this <code>GatewayReceiver</code>'s |
| clients (i.e. the GatewaySenders). The default is 60000 ms.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum amount of time between client pings.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre>int getPort()</pre> |
| <div class="block">Returns the port on which this <code>GatewayReceiver</code> listens for clients.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the port on which this <code>GatewayReceiver</code> listens for clients</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStartPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartPort</h4> |
| <pre>int getStartPort()</pre> |
| <div class="block">Returns start value of the port range from which the <code>GatewayReceiver</code>'s port will |
| be chosen.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the start value of the port range from which the <code>GatewayReceiver</code>'s port will be |
| chosen</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEndPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndPort</h4> |
| <pre>int getEndPort()</pre> |
| <div class="block">Returns end value of the port range from which the <code>GatewayReceiver</code>'s port will be |
| chosen.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the end value of the port range from which the <code>GatewayReceiver</code>'s port will be |
| chosen</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHost--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</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> getHost()</pre> |
| <div class="block">Returns a string representing the ip address or host name that server locators will tell |
| clients (<code>GatewaySender</code>s in this case) that this receiver is listening on.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ip address or host name to give to clients so they can connect to this receiver</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHostnameForSenders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostnameForSenders</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> getHostnameForSenders()</pre> |
| <div class="block">Returns the hostname configured by <a href="../../../../../org/apache/geode/cache/wan/GatewayReceiverFactory.html#setHostnameForSenders-java.lang.String-"><code>GatewayReceiverFactory.setHostnameForSenders(String)</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the hostname configured by <a href="../../../../../org/apache/geode/cache/wan/GatewayReceiverFactory.html#setHostnameForSenders-java.lang.String-"><code>GatewayReceiverFactory.setHostnameForSenders(String)</code></a></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 for this |
| <code>GatewayReceiver</code>. The default is 524288 bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured buffer size of the socket connection for this |
| <code>GatewayReceiver</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBindAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBindAddress</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBindAddress()</pre> |
| <div class="block">Returns a string representing the ip address or host name that this server will listen on.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ip address or host name that this server is to listen on</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html#DEFAULT_BIND_ADDRESS"><code>DEFAULT_BIND_ADDRESS</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isManualStart--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isManualStart</h4> |
| <pre>boolean isManualStart()</pre> |
| <div class="block">Returns the manual start boolean property for this GatewayReceiver. Default is true i.e. the |
| GatewayReceiver will not automatically start once created.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the manual start boolean property for this GatewayReceiver</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServer--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getServer</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server">CacheServer</a> getServer()</pre> |
| <div class="block">Return the underlying Cacheserver</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the underlying Cacheserver</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/GatewayQueueEvent.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/GatewayReceiverFactory.html" title="interface 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/GatewayReceiver.html" target="_top">Frames</a></li> |
| <li><a href="GatewayReceiver.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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> |