blob: 7d270d0a9e739554d1d1ca3ead4588333949b4e5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_252) on Thu Sep 03 11:54:23 CEST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TCPRemoteCommitProvider (OpenJPA Parent POM 3.1.2 API)</title>
<meta name="date" content="2020-09-03">
<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="TCPRemoteCommitProvider (OpenJPA Parent POM 3.1.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":42,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="class-use/TCPRemoteCommitProvider.html">Use</a></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/openjpa/event/StoreListener.html" title="interface in org.apache.openjpa.event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.HostAddress.html" title="class in org.apache.openjpa.event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/event/TCPRemoteCommitProvider.html" target="_top">Frames</a></li>
<li><a href="TCPRemoteCommitProvider.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.openjpa.event</div>
<h2 title="Class TCPRemoteCommitProvider" class="title">Class TCPRemoteCommitProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html" title="class in org.apache.openjpa.event">org.apache.openjpa.event.AbstractRemoteCommitProvider</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.event.TCPRemoteCommitProvider</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html" title="interface in org.apache.openjpa.event">RemoteCommitProvider</a>, <a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a>, <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/openjpa/event/DynamicTCPRemoteCommitProvider.html" title="class in org.apache.openjpa.event">DynamicTCPRemoteCommitProvider</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TCPRemoteCommitProvider</span>
extends <a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html" title="class in org.apache.openjpa.event">AbstractRemoteCommitProvider</a>
implements <a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></pre>
<div class="block">TCP-based implementation of <a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html" title="interface in org.apache.openjpa.event"><code>RemoteCommitProvider</code></a> that
listens for object modifications and propagates those changes to
other RemoteCommitProviders over TCP sockets.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.2.5.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Brian Leair, Patrick Linskey</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.HostAddress.html" title="class in org.apache.openjpa.event">TCPRemoteCommitProvider.HostAddress</a></span></code>
<div class="block">Utility class to store an InetAddress and an int.</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">&nbsp;</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>protected <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>&lt;<a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.HostAddress.html" title="class in org.apache.openjpa.event">TCPRemoteCommitProvider.HostAddress</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#Z:Z_addresses">_addresses</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantLock.html?is-external=true" title="class or interface in java.util.concurrent.locks">ReentrantLock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#Z:Z_addressesLock">_addressesLock</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#Z:Z_port">_port</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <a href="../../../../org/apache/openjpa/lib/util/Localizer.html" title="class in org.apache.openjpa.lib.util">Localizer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#s_loc">s_loc</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.event.AbstractRemoteCommitProvider">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.event.<a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html" title="class in org.apache.openjpa.event">AbstractRemoteCommitProvider</a></h3>
<code><a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html#eventManager">eventManager</a>, <a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html#log">log</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#TCPRemoteCommitProvider--">TCPRemoteCommitProvider</a></span>()</code>&nbsp;</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">&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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#broadcast-org.apache.openjpa.event.RemoteCommitEvent-">broadcast</a></span>(<a href="../../../../org/apache/openjpa/event/RemoteCommitEvent.html" title="class in org.apache.openjpa.event">RemoteCommitEvent</a>&nbsp;event)</code>
<div class="block">Notifies other remote event managers in this JVM and on other machines
of changes to the cache.</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/openjpa/event/TCPRemoteCommitProvider.html#close--">close</a></span>()</code>
<div class="block">Free the resources used by this provider.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#endConfiguration--">endConfiguration</a></span>()</code>
<div class="block">Subclasses that need to perform actions in
<a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration--"><code>Configurable.endConfiguration()</code></a> must invoke this method.</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/openjpa/event/TCPRemoteCommitProvider.html#getMaxIdle--">getMaxIdle</a></span>()</code>&nbsp;</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/openjpa/event/TCPRemoteCommitProvider.html#getMaxTotal--">getMaxTotal</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#getNumBroadcastThreads--">getNumBroadcastThreads</a></span>()</code>&nbsp;</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/openjpa/event/TCPRemoteCommitProvider.html#getPort--">getPort</a></span>()</code>&nbsp;</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/openjpa/event/TCPRemoteCommitProvider.html#getRecoveryTimeMillis--">getRecoveryTimeMillis</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#setAddresses-java.lang.String-">setAddresses</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;names)</code>
<div class="block">Sets the list of addresses of peers to which this provider will send events to.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#setMaxActive-int-">setMaxActive</a></span>(int&nbsp;maxActive)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#setMaxIdle-int-">setMaxIdle</a></span>(int&nbsp;maxIdle)</code>
<div class="block">Set the number of idle sockets that this provider can keep open to each peer in the cluster.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#setMaxTotal-int-">setMaxTotal</a></span>(int&nbsp;maxTotal)</code>
<div class="block">Set the maximum total number of sockets that this provider can simultaneously open to each peer in the cluster.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#setNumBroadcastThreads-int-">setNumBroadcastThreads</a></span>(int&nbsp;numBroadcastThreads)</code>
<div class="block">Set the number of worker threads that are used for transmitting packets to peers in the cluster.</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/openjpa/event/TCPRemoteCommitProvider.html#setPort-int-">setPort</a></span>(int&nbsp;port)</code>
<div class="block">Set the port that this provider should listen on.</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/openjpa/event/TCPRemoteCommitProvider.html#setRecoveryTimeMillis-int-">setRecoveryTimeMillis</a></span>(int&nbsp;recoverytime)</code>
<div class="block">Set the number of milliseconds to wait before retrying to reconnect to a peer after it becomes unreachable.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.event.AbstractRemoteCommitProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.event.<a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html" title="class in org.apache.openjpa.event">AbstractRemoteCommitProvider</a></h3>
<code><a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html#fireEvent-org.apache.openjpa.event.RemoteCommitEvent-">fireEvent</a>, <a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html#setConfiguration-org.apache.openjpa.lib.conf.Configuration-">setConfiguration</a>, <a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html#setRemoteCommitEventManager-org.apache.openjpa.event.RemoteCommitEventManager-">setRemoteCommitEventManager</a>, <a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html#startConfiguration--">startConfiguration</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.lib.conf.Configurable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.lib.conf.<a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></h3>
<code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#setConfiguration-org.apache.openjpa.lib.conf.Configuration-">setConfiguration</a>, <a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#startConfiguration--">startConfiguration</a></code></li>
</ul>
</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="s_loc">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>s_loc</h4>
<pre>protected static final&nbsp;<a href="../../../../org/apache/openjpa/lib/util/Localizer.html" title="class in org.apache.openjpa.lib.util">Localizer</a> s_loc</pre>
</li>
</ul>
<a name="Z:Z_port">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_port</h4>
<pre>protected&nbsp;int _port</pre>
</li>
</ul>
<a name="Z:Z_addresses">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_addresses</h4>
<pre>protected&nbsp;<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>&lt;<a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.HostAddress.html" title="class in org.apache.openjpa.event">TCPRemoteCommitProvider.HostAddress</a>&gt; _addresses</pre>
</li>
</ul>
<a name="Z:Z_addressesLock">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_addressesLock</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantLock.html?is-external=true" title="class or interface in java.util.concurrent.locks">ReentrantLock</a> _addressesLock</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TCPRemoteCommitProvider--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TCPRemoteCommitProvider</h4>
<pre>public&nbsp;TCPRemoteCommitProvider()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/net/UnknownHostException.html?is-external=true" title="class or interface in java.net">UnknownHostException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/UnknownHostException.html?is-external=true" title="class or interface in java.net">UnknownHostException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPort</h4>
<pre>public&nbsp;int&nbsp;getPort()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the port that this provider should listen on.</dd>
</dl>
</li>
</ul>
<a name="setPort-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPort</h4>
<pre>public&nbsp;void&nbsp;setPort(int&nbsp;port)</pre>
<div class="block">Set the port that this provider should listen on. Set once only.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>port</code> - the port that this provider should listen on</dd>
</dl>
</li>
</ul>
<a name="setRecoveryTimeMillis-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecoveryTimeMillis</h4>
<pre>public&nbsp;void&nbsp;setRecoveryTimeMillis(int&nbsp;recoverytime)</pre>
<div class="block">Set the number of milliseconds to wait before retrying to reconnect to a peer after it becomes unreachable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recoverytime</code> - the number of milliseconds to wait before retrying to reconnect to a peer after it becomes
unreachable</dd>
</dl>
</li>
</ul>
<a name="getRecoveryTimeMillis--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecoveryTimeMillis</h4>
<pre>public&nbsp;int&nbsp;getRecoveryTimeMillis()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of milliseconds to wait before retrying to reconnect to a peer after it becomes unreachable.</dd>
</dl>
</li>
</ul>
<a name="setMaxActive-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxActive</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>
public&nbsp;void&nbsp;setMaxActive(int&nbsp;maxActive)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Set the maximum number of sockets that this provider can simultaneously open to each peer in the cluster.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxActive</code> - the maximum total number of sockets that this provider can simultaneously open to each peer in
the cluster. * @deprecated please use <a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html#setMaxTotal-int-"><code>setMaxTotal(int)</code></a> instead</dd>
</dl>
</li>
</ul>
<a name="setMaxTotal-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxTotal</h4>
<pre>public&nbsp;void&nbsp;setMaxTotal(int&nbsp;maxTotal)</pre>
<div class="block">Set the maximum total number of sockets that this provider can simultaneously open to each peer in the cluster.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxTotal</code> - the maximum total number of sockets that this provider can simultaneously open to each peer in
the cluster.</dd>
</dl>
</li>
</ul>
<a name="getMaxTotal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxTotal</h4>
<pre>public&nbsp;int&nbsp;getMaxTotal()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of sockets that this provider can simultaneously open to each peer in the cluster.</dd>
</dl>
</li>
</ul>
<a name="setMaxIdle-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxIdle</h4>
<pre>public&nbsp;void&nbsp;setMaxIdle(int&nbsp;maxIdle)</pre>
<div class="block">Set the number of idle sockets that this provider can keep open to each peer in the cluster.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxIdle</code> - the number of idle sockets that this provider can keep open to each peer in the cluster</dd>
</dl>
</li>
</ul>
<a name="getMaxIdle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxIdle</h4>
<pre>public&nbsp;int&nbsp;getMaxIdle()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of idle sockets that this provider can keep open to each peer in the cluster.</dd>
</dl>
</li>
</ul>
<a name="setNumBroadcastThreads-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumBroadcastThreads</h4>
<pre>public&nbsp;void&nbsp;setNumBroadcastThreads(int&nbsp;numBroadcastThreads)</pre>
<div class="block">Set the number of worker threads that are used for transmitting packets to peers in the cluster.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numBroadcastThreads</code> - the number of worker threads that are used for transmitting packets to peers in the
cluster</dd>
</dl>
</li>
</ul>
<a name="getNumBroadcastThreads--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumBroadcastThreads</h4>
<pre>public&nbsp;int&nbsp;getNumBroadcastThreads()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of worker threads that are used for transmitting packets to peers in the cluster.</dd>
</dl>
</li>
</ul>
<a name="setAddresses-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAddresses</h4>
<pre>public&nbsp;void&nbsp;setAddresses(<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;names)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/net/UnknownHostException.html?is-external=true" title="class or interface in java.net">UnknownHostException</a></pre>
<div class="block">Sets the list of addresses of peers to which this provider will send events to.
The peers are semicolon-separated <code>names</code> list in the form of "myhost1:portA;myhost2:portB".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>names</code> - the list of addresses of peers to which this provider will send events to</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/UnknownHostException.html?is-external=true" title="class or interface in java.net">UnknownHostException</a></code> - in case peer name cannot be resolved</dd>
</dl>
</li>
</ul>
<a name="endConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endConfiguration</h4>
<pre>public&nbsp;void&nbsp;endConfiguration()</pre>
<div class="block">Subclasses that need to perform actions in
<a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration--"><code>Configurable.endConfiguration()</code></a> must invoke this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration--">endConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html#endConfiguration--">endConfiguration</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html" title="class in org.apache.openjpa.event">AbstractRemoteCommitProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="broadcast-org.apache.openjpa.event.RemoteCommitEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>broadcast</h4>
<pre>public&nbsp;void&nbsp;broadcast(<a href="../../../../org/apache/openjpa/event/RemoteCommitEvent.html" title="class in org.apache.openjpa.event">RemoteCommitEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html#broadcast-org.apache.openjpa.event.RemoteCommitEvent-">RemoteCommitProvider</a></code></span></div>
<div class="block">Notifies other remote event managers in this JVM and on other machines
of changes to the cache. This method must not notify the
event manager associated with the broker that originated this commit.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html#broadcast-org.apache.openjpa.event.RemoteCommitEvent-">broadcast</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html" title="interface in org.apache.openjpa.event">RemoteCommitProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html#close--">RemoteCommitProvider</a></code></span></div>
<div class="block">Free the resources used by this provider.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html" title="interface in org.apache.openjpa.event">RemoteCommitProvider</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code></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="class-use/TCPRemoteCommitProvider.html">Use</a></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/openjpa/event/StoreListener.html" title="interface in org.apache.openjpa.event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.HostAddress.html" title="class in org.apache.openjpa.event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/event/TCPRemoteCommitProvider.html" target="_top">Frames</a></li>
<li><a href="TCPRemoteCommitProvider.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>