Google Git
Sign in
apache / geode-site / caddaef03c4320a2dfa150b53db94c7a971ecf4e / . / releases / latest / javadoc / org / apache / geode / cache / wan / GatewaySenderFactory.html
blob: 32df96cab4071b1146d1ea02bf27bb82c9aa8d85 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_272) on Thu Nov 12 16:27:24 PST 2020 -->
<title>GatewaySenderFactory (Apache Geode 1.13.1)</title>
<meta name="date" content="2020-11-12">
<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="GatewaySenderFactory (Apache Geode 1.13.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":38,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":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/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/cache/wan/GatewaySenderFactory.html" target="_top">Frames</a></li>
<li><a href="GatewaySenderFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.geode.cache.wan</div>
<h2 title="Interface GatewaySenderFactory" class="title">Interface GatewaySenderFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">GatewaySenderFactory</span></pre>
<div class="block">Factory to create SerialGatewaySender</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 7.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySender</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.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>&nbsp;filter)</code>
<div class="block">Adds a <code>GatewayEventFilter</code></div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#addGatewayTransportFilter-org.apache.geode.cache.wan.GatewayTransportFilter-">addGatewayTransportFilter</a></span>(<a href="../../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan">GatewayTransportFilter</a>&nbsp;filter)</code>
<div class="block">Adds a <code>GatewayTransportFilter</code></div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan">GatewaySender</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#create-java.lang.String-int-">create</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id,
int&nbsp;remoteDSId)</code>
<div class="block">Creates a <code>GatewaySender</code> to communicate with remote distributed system</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.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>&nbsp;filter)</code>
<div class="block">Removes the provided <code>GatewayEventFilter</code> from this GatewaySender.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#removeGatewayTransportFilter-org.apache.geode.cache.wan.GatewayTransportFilter-">removeGatewayTransportFilter</a></span>(<a href="../../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan">GatewayTransportFilter</a>&nbsp;filter)</code>
<div class="block">Removes the provided <code>GatewayTransportFilter</code> from this GatewaySender.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setAlertThreshold-int-">setAlertThreshold</a></span>(int&nbsp;threshold)</code>
<div class="block">Sets the alert threshold in milliseconds for entries in a <code>GatewaySender</code> 's queue.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setBatchConflationEnabled-boolean-">setBatchConflationEnabled</a></span>(boolean&nbsp;isConflation)</code>
<div class="block">Sets whether to enable batch conflation for a <code>GatewaySender</code>'s queue.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setBatchSize-int-">setBatchSize</a></span>(int&nbsp;size)</code>
<div class="block">Sets the batch size to be picked at the time of dispatching from a <code>GatewaySender</code>'s
queue.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setBatchTimeInterval-int-">setBatchTimeInterval</a></span>(int&nbsp;interval)</code>
<div class="block">Sets a time interval in milliseconds to wait to form a batch to be dispatched from a
<code>GatewaySender</code>'s queue.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setDiskStoreName-java.lang.String-">setDiskStoreName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Sets the disk store name for overflow or persistence</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setDiskSynchronous-boolean-">setDiskSynchronous</a></span>(boolean&nbsp;isSynchronous)</code>
<div class="block">Sets whether or not the writing to the disk is synchronous.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setDispatcherThreads-int-">setDispatcherThreads</a></span>(int&nbsp;numThreads)</code>
<div class="block">Sets the number of dispatcher thread.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setGatewayEventSubstitutionFilter-org.apache.geode.cache.wan.GatewayEventSubstitutionFilter-">setGatewayEventSubstitutionFilter</a></span>(<a href="../../../../../org/apache/geode/cache/wan/GatewayEventSubstitutionFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventSubstitutionFilter</a>&nbsp;filter)</code>
<div class="block">Sets the provided <code>GatewayEventSubstitutionFilter</code> in this GatewaySenderFactory.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setManualStart-boolean-">setManualStart</a></span>(boolean&nbsp;start)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<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="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setMaximumQueueMemory-int-">setMaximumQueueMemory</a></span>(int&nbsp;maxQueueMemory)</code>
<div class="block">Sets the maximum amount of memory (in MB) for a <code>GatewaySender</code>'s queue.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setOrderPolicy-org.apache.geode.cache.wan.GatewaySender.OrderPolicy-">setOrderPolicy</a></span>(<a href="../../../../../org/apache/geode/cache/wan/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan">GatewaySender.OrderPolicy</a>&nbsp;policy)</code>
<div class="block">Sets <code>OrderPolicy</code> for this GatewaySender.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setParallel-boolean-">setParallel</a></span>(boolean&nbsp;isParallel)</code>
<div class="block">Indicates whether all VMs need to distribute events to remote site.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setParallelFactorForReplicatedRegion-int-">setParallelFactorForReplicatedRegion</a></span>(int&nbsp;parallel)</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setPersistenceEnabled-boolean-">setPersistenceEnabled</a></span>(boolean&nbsp;isPersistence)</code>
<div class="block">Sets whether to enable persistence for a <code>GatewaySender</code>'s queue.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setSocketBufferSize-int-">setSocketBufferSize</a></span>(int&nbsp;size)</code>
<div class="block">Sets the buffer size in bytes of the socket connection for this <code>GatewaySender</code>.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html#setSocketReadTimeout-int-">setSocketReadTimeout</a></span>(int&nbsp;timeout)</code>
<div class="block">Sets the number of milliseconds to wait for a response from a <code>GatewayReceiver</code>
before timing out the operation and trying another <code>GatewayReceiver</code> (if any are
available).</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setParallel-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParallel</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setParallel(boolean&nbsp;isParallel)</pre>
<div class="block">Indicates whether all VMs need to distribute events to remote site. In this case only the
events originating in a particular VM will be in dispatched in order.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>isParallel</code> - boolean to indicate whether distribution policy is parallel</dd>
</dl>
</li>
</ul>
<a name="addGatewayEventFilter-org.apache.geode.cache.wan.GatewayEventFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGatewayEventFilter</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;addGatewayEventFilter(<a href="../../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a>&nbsp;filter)</pre>
<div class="block">Adds a <code>GatewayEventFilter</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - GatewayEventFilter</dd>
</dl>
</li>
</ul>
<a name="addGatewayTransportFilter-org.apache.geode.cache.wan.GatewayTransportFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGatewayTransportFilter</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;addGatewayTransportFilter(<a href="../../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan">GatewayTransportFilter</a>&nbsp;filter)</pre>
<div class="block">Adds a <code>GatewayTransportFilter</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - GatewayTransportFilter</dd>
</dl>
</li>
</ul>
<a name="setSocketBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSocketBufferSize</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setSocketBufferSize(int&nbsp;size)</pre>
<div class="block">Sets the buffer size in bytes of the socket connection for this <code>GatewaySender</code>. The
default is 32768 bytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - The size in bytes of the socket buffer</dd>
</dl>
</li>
</ul>
<a name="setSocketReadTimeout-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSocketReadTimeout</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setSocketReadTimeout(int&nbsp;timeout)</pre>
<div class="block">Sets the number of milliseconds to wait for a response from a <code>GatewayReceiver</code>
before timing out the operation and trying another <code>GatewayReceiver</code> (if any are
available). Default is 0 which means infinite timeout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - number of milliseconds to wait for a response from a GatewayReceiver</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>timeout</code> is less than <code>0</code>.</dd>
</dl>
</li>
</ul>
<a name="setDiskStoreName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDiskStoreName</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setDiskStoreName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Sets the disk store name for overflow or persistence</div>
</li>
</ul>
<a name="setDispatcherThreads-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDispatcherThreads</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setDispatcherThreads(int&nbsp;numThreads)</pre>
<div class="block">Sets the number of dispatcher thread. Default number of dispatcher threads is 5.</div>
</li>
</ul>
<a name="setOrderPolicy-org.apache.geode.cache.wan.GatewaySender.OrderPolicy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOrderPolicy</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setOrderPolicy(<a href="../../../../../org/apache/geode/cache/wan/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan">GatewaySender.OrderPolicy</a>&nbsp;policy)</pre>
<div class="block">Sets <code>OrderPolicy</code> for this GatewaySender. Default order policy is KEY.</div>
</li>
</ul>
<a name="setMaximumQueueMemory-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaximumQueueMemory</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setMaximumQueueMemory(int&nbsp;maxQueueMemory)</pre>
<div class="block">Sets the maximum amount of memory (in MB) for a <code>GatewaySender</code>'s queue. Default is
100.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxQueueMemory</code> - The maximum amount of memory (in MB) for a <code>GatewaySender</code>'s
queue.</dd>
</dl>
</li>
</ul>
<a name="setBatchSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBatchSize</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setBatchSize(int&nbsp;size)</pre>
<div class="block">Sets the batch size to be picked at the time of dispatching from a <code>GatewaySender</code>'s
queue. Default batchSize is 100.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - The size of batches sent from a <code>GatewaySender</code> to its corresponding
<code>GatewayReceiver</code>.</dd>
</dl>
</li>
</ul>
<a name="setBatchTimeInterval-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBatchTimeInterval</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setBatchTimeInterval(int&nbsp;interval)</pre>
<div class="block">Sets a time interval in milliseconds to wait to form a batch to be dispatched from a
<code>GatewaySender</code>'s queue. Default is 1000.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interval</code> - The maximum time interval (in milliseconds) that can elapse before a partial
batch is sent from a <code>GatewaySender</code> to its corresponding
<code>GatewayReceiver</code>.</dd>
</dl>
</li>
</ul>
<a name="setBatchConflationEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBatchConflationEnabled</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setBatchConflationEnabled(boolean&nbsp;isConflation)</pre>
<div class="block">Sets whether to enable batch conflation for a <code>GatewaySender</code>'s queue. Default is
false.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>isConflation</code> - Whether or not to enable batch conflation for batches sent from a
<code>GatewaySender</code> to its corresponding <code>GatewayReceiver</code>.</dd>
</dl>
</li>
</ul>
<a name="setPersistenceEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPersistenceEnabled</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setPersistenceEnabled(boolean&nbsp;isPersistence)</pre>
<div class="block">Sets whether to enable persistence for a <code>GatewaySender</code>'s queue. Default is false.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>isPersistence</code> - Whether to enable persistence for a <code>GatewaySender</code>'s queue</dd>
</dl>
</li>
</ul>
<a name="setAlertThreshold-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAlertThreshold</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setAlertThreshold(int&nbsp;threshold)</pre>
<div class="block">Sets the alert threshold in milliseconds for entries in a <code>GatewaySender</code> 's queue.
Default value is 0.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>threshold</code> - the alert threshold for entries in a <code>GatewaySender</code>'s queue</dd>
</dl>
</li>
</ul>
<a name="setManualStart-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setManualStart</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>
<a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setManualStart(boolean&nbsp;start)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">- Manual start of senders is deprecated and will be removed in a later release.</span></div>
<div class="block">Sets the manual start boolean property for this <code>GatewaySender</code>. Default is false
i.e. the <code>GatewaySender</code> will automatically start once created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>start</code> - the manual start boolean property for this <code>GatewaySender</code></dd>
</dl>
</li>
</ul>
<a name="setDiskSynchronous-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDiskSynchronous</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setDiskSynchronous(boolean&nbsp;isSynchronous)</pre>
<div class="block">Sets whether or not the writing to the disk is synchronous. Default is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>isSynchronous</code> - boolean if true indicates synchronous writes</dd>
</dl>
</li>
</ul>
<a name="removeGatewayEventFilter-org.apache.geode.cache.wan.GatewayEventFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeGatewayEventFilter</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;removeGatewayEventFilter(<a href="../../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a>&nbsp;filter)</pre>
<div class="block">Removes the provided <code>GatewayEventFilter</code> from this GatewaySender.</div>
</li>
</ul>
<a name="removeGatewayTransportFilter-org.apache.geode.cache.wan.GatewayTransportFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeGatewayTransportFilter</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;removeGatewayTransportFilter(<a href="../../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan">GatewayTransportFilter</a>&nbsp;filter)</pre>
<div class="block">Removes the provided <code>GatewayTransportFilter</code> from this GatewaySender.</div>
</li>
</ul>
<a name="setParallelFactorForReplicatedRegion-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParallelFactorForReplicatedRegion</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setParallelFactorForReplicatedRegion(int&nbsp;parallel)</pre>
</li>
</ul>
<a name="setGatewayEventSubstitutionFilter-org.apache.geode.cache.wan.GatewayEventSubstitutionFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGatewayEventSubstitutionFilter</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;setGatewayEventSubstitutionFilter(<a href="../../../../../org/apache/geode/cache/wan/GatewayEventSubstitutionFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventSubstitutionFilter</a>&nbsp;filter)</pre>
<div class="block">Sets the provided <code>GatewayEventSubstitutionFilter</code> in this GatewaySenderFactory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - The <code>GatewayEventSubstitutionFilter</code></dd>
</dl>
</li>
</ul>
<a name="create-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>create</h4>
<pre><a href="../../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan">GatewaySender</a>&nbsp;create(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id,
int&nbsp;remoteDSId)</pre>
<div class="block">Creates a <code>GatewaySender</code> to communicate with remote distributed system</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - unique id for this SerialGatewaySender</dd>
<dd><code>remoteDSId</code> - unique id representing the remote distributed system</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>instance of SerialGatewaySender</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the GatewaySender creation fails during validation due to
mismatch of attributes of GatewaySender created on other nodes with same id</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/GatewaySender.OrderPolicy.html" title="enum in org.apache.geode.cache.wan"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/cache/wan/GatewaySenderFactory.html" target="_top">Frames</a></li>
<li><a href="GatewaySenderFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>