| <!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>org.apache.geode.distributed (Apache Geode 1.15.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.geode.distributed (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/datasource/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/geode/examples/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/distributed/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.geode.distributed</h1> |
| <div class="docSummary"> |
| <div class="block">Provides information about, access to, and common tools for GemFire |
| distributed systems.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/ClientSocketFactory.html" title="interface in org.apache.geode.distributed">ClientSocketFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Interface <code>ClientSocketFactory</code> is used to create non-default client sockets.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/ConfigurationPersistenceService.html" title="interface in org.apache.geode.distributed">ConfigurationPersistenceService</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/ConfigurationProperties.html" title="interface in org.apache.geode.distributed">ConfigurationProperties</a></td> |
| <td class="colLast"> |
| <div class="block">This interface defines all the configuration properties that can be used.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a></td> |
| <td class="colLast"> |
| <div class="block">This is the fundamental representation of a member in a GemFire distributed system.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/Role.html" title="interface in org.apache.geode.distributed">Role</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">this feature is scheduled to be removed</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/ServerLauncherCacheProvider.html" title="interface in org.apache.geode.distributed">ServerLauncherCacheProvider</a></td> |
| <td class="colLast"> |
| <div class="block">ServerLauncherCacheProvider is an extension point for overriding the behavior of a server started |
| with <a href="../../../../org/apache/geode/distributed/ServerLauncher.html" title="class in org.apache.geode.distributed"><code>ServerLauncher</code></a> or the gfsh start server command.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a><T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><T>></td> |
| <td class="colLast"> |
| <div class="block">The AbstractLauncher class is a base class for implementing various launchers to construct and |
| run different GemFire processes, like Cache Servers, Locators, Managers, HTTP servers and so on.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.ServiceState.html" title="class in org.apache.geode.distributed">AbstractLauncher.ServiceState</a><T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><T>></td> |
| <td class="colLast"> |
| <div class="block">The ServiceState is an immutable type representing the state of the specified Locator at any |
| given moment in time.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/DistributedLockService.html" title="class in org.apache.geode.distributed">DistributedLockService</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| A named instance of DistributedLockService defines a space for locking arbitrary names across the |
| distributed system defined by a specified distribution manager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a></td> |
| <td class="colLast"> |
| <div class="block">A "connection" to a GemFire distributed system.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/DurableClientAttributes.html" title="class in org.apache.geode.distributed">DurableClientAttributes</a></td> |
| <td class="colLast"> |
| <div class="block">Class <code>DurableClientAttributes</code> represents durable member attributes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a distribution locator server that provides discovery information to members and |
| clients of a GemFire distributed system.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed">LocatorLauncher</a></td> |
| <td class="colLast"> |
| <div class="block">The LocatorLauncher class is a launcher for a Geode Locator.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></td> |
| <td class="colLast"> |
| <div class="block">Following the Builder design pattern, the LocatorLauncher Builder is used to configure and |
| create a properly initialized instance of the LocatorLauncher class for running the Locator and |
| performing other Locator operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a></td> |
| <td class="colLast"> |
| <div class="block">The LocatorState is an immutable type representing the state of the specified Locator at any |
| given moment in time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html" title="class in org.apache.geode.distributed">ServerLauncher</a></td> |
| <td class="colLast"> |
| <div class="block">The ServerLauncher class is a launcher class with main method to start a Geode Server (implying |
| a Geode Cache Server process).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></td> |
| <td class="colLast"> |
| <div class="block">The Builder class, modeled after the Builder creational design pattern, is used to construct a |
| properly configured and initialized instance of the ServerLauncher to control and run Geode |
| servers (in particular, cache servers).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a></td> |
| <td class="colLast"> |
| <div class="block">The ServerState is an immutable type representing the state of the specified Server at any |
| given moment in time.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html" title="enum in org.apache.geode.distributed">AbstractLauncher.Status</a></td> |
| <td class="colLast"> |
| <div class="block">The Status enumerated type represents the various lifecycle states of a GemFire service (such |
| as a Cache Server, a Locator or a Manager).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed">LocatorLauncher.Command</a></td> |
| <td class="colLast"> |
| <div class="block">An enumerated type representing valid commands to the Locator launcher.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a></td> |
| <td class="colLast"> |
| <div class="block">An enumerated type representing valid commands to the Server launcher.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/ServerLauncherParameters.html" title="enum in org.apache.geode.distributed">ServerLauncherParameters</a></td> |
| <td class="colLast"> |
| <div class="block">GEODE-5256: Parameters containing startup options specified by the user.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/DistributedSystemDisconnectedException.html" title="class in org.apache.geode.distributed">DistributedSystemDisconnectedException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when a GemFire distributed system has been terminated.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/FutureCancelledException.html" title="class in org.apache.geode.distributed">FutureCancelledException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> has been cancelled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/GatewayCancelledException.html" title="class in org.apache.geode.distributed">GatewayCancelledException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when a GemFire WAN gateway has been terminated.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/LeaseExpiredException.html" title="class in org.apache.geode.distributed">LeaseExpiredException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>LeaseExpiredException</code> is thrown when GemFire detects that a distributed lock |
| obtained by the current thread with a limited lease (see @link DistributedLockService} has |
| expired before it was explicitly released.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/LockNotHeldException.html" title="class in org.apache.geode.distributed">LockNotHeldException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>LockNotHeldException</code> is thrown when attempting unlock a lock that is not held by |
| the thread performing the unlock.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/LockServiceDestroyedException.html" title="class in org.apache.geode.distributed">LockServiceDestroyedException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>LockServiceDestroyedException</code> is thrown when attempting use a distributed lock |
| service that has been destroyed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/OplogCancelledException.html" title="class in org.apache.geode.distributed">OplogCancelledException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when a GemFire operation log has been terminated.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/PoolCancelledException.html" title="class in org.apache.geode.distributed">PoolCancelledException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when a GemFire connection pool has been terminated.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/distributed/TXManagerCancelledException.html" title="class in org.apache.geode.distributed">TXManagerCancelledException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when a GemFire transaction manager has been terminated.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.geode.distributed Description">Package org.apache.geode.distributed Description</h2> |
| <div class="block"><P>Provides information about, access to, and common tools for GemFire |
| distributed systems. When a program wishes to access distributed dtaa |
| data stored in GemFire, it first creates a <a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed"><code>DistributedSystem</code></a> that will connect |
| to the distributed system. GemFire provides two means of discovering |
| the other members in a distributed group. The first uses IP multicast |
| to broadcast a message to all members that listen on a given <A |
| href="DistributedSystem.html#mcast-port"/>port</A> and <A |
| href="DistributedSystem.html#mcast-address">address</A>. The second |
| method of discovery uses special VMs called <a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">"locators"</a> to keep track of |
| the members of the distributed system. Each locator is identified by |
| a host/port pair that is <A |
| href="DistributedSystem.html#locators">specified</A> when connecting |
| to the distributed system.</P></div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/datasource/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/geode/examples/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/distributed/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
