org.apache.geode.distributed (Apache Geode 1.5.0)
Date: 2018-03-30

# Package org.apache.geode.distributed

Provides information about, access to, and common tools for GemFire distributed systems.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  ClientSocketFactory | Interface `ClientSocketFactory` is used to create non-default client sockets.
  ConfigurationProperties | This interface defines all the configuration properties that can be used.
  DistributedMember | This is the fundamental representation of a member in a GemFire distributed system.
  Role | Deprecated this feature is scheduled to be removed
  ServerLauncherCacheProvider | ServerLauncherCacheProvider is an extension point for overriding the behavior of a server started with `ServerLauncher` or the gfsh start server command.

- Class Summary
  Class | Description
  --- | ---
  AbstractLauncher<T extends java.lang.Comparable<T>> | 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.
  AbstractLauncher.ServiceState<T extends java.lang.Comparable<T>> | The ServiceState is an immutable type representing the state of the specified Locator at any given moment in time.
  DistributedLockService | A named instance of DistributedLockService defines a space for locking arbitrary names across the distributed system defined by a specified distribution manager.
  DistributedSystem | A "connection" to a GemFire distributed system.
  DurableClientAttributes | Class `DurableClientAttributes` represents durable member attributes.
  Locator | Represents a distribution locator server that provides discovery information to members and clients of a GemFire distributed system.
  LocatorLauncher | The LocatorLauncher class is a launcher for a GemFire Locator.
  LocatorLauncher.Builder | 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.
  LocatorLauncher.LocatorState | The LocatorState is an immutable type representing the state of the specified Locator at any given moment in time.
  ServerLauncher | The ServerLauncher class is a launcher class with main method to start a GemFire Server (implying a GemFire Cache Server process).
  ServerLauncher.Builder | 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 GemFire servers (in particular, cache servers).
  ServerLauncher.ServerState | The ServerState is an immutable type representing the state of the specified Server at any given moment in time.

- Enum Summary
  Enum | Description
  --- | ---
  AbstractLauncher.Status | The Status enumerated type represents the various lifecycle states of a GemFire service (such as a Cache Server, a Locator or a Manager).
  LocatorLauncher.Command | An enumerated type representing valid commands to the Locator launcher.
  ServerLauncher.Command | An enumerated type representing valid commands to the Server launcher.

- Exception Summary
  Exception | Description
  --- | ---
  DistributedSystemDisconnectedException | Thrown when a GemFire distributed system has been terminated.
  FutureCancelledException | Thrown when a `Future` has been cancelled.
  GatewayCancelledException | Thrown when a GemFire WAN gateway has been terminated.
  LeaseExpiredException | A `LeaseExpiredException` 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.
  LockNotHeldException | A `LockNotHeldException` is thrown when attempting unlock a lock that is not held by the thread performing the unlock.
  LockServiceDestroyedException | A `LockServiceDestroyedException` is thrown when attempting use a distributed lock service that has been destroyed.
  OplogCancelledException | Thrown when a GemFire operation log has been terminated.
  PoolCancelledException | Thrown when a GemFire connection pool has been terminated.
  TXManagerCancelledException | Thrown when a GemFire transaction manager has been terminated.

## Package org.apache.geode.distributed Description

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 `DistributedSystem` 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 port and address. The second method of discovery uses special VMs called "locators" to keep track of the members of the distributed system. Each locator is identified by a host/port pair that is specified when connecting to the distributed system.