 | Akka.Cluster Namespace |
Classes| Class | Description | |
|---|---|---|
 | AutoDowning |
Used when no custom provider is configured and 'auto-down-unreachable-after' is enabled.
|
| Cluster | This class represents an ActorSystem extension used to create, monitor and manage a cluster of member nodes hosted within the actor system. Each cluster Member is identified by its Address and the cluster address of this actor system is SelfAddress. A member also has a status; initially Joining followed by Up. |
| ClusterEvent |
Domain events published to the event bus.
Subscribe with:
var cluster = new Cluster(system); cluster.Subscribe(actorRef, typeof(IClusterDomainEvent)); |
| ClusterEventClusterShuttingDown |
Indicates that the Cluster plugin is shutting down.
|
| ClusterEventCurrentClusterState |
A snapshot of the current state of the Cluster |
| ClusterEventLeaderChanged |
Leader of the cluster members changed. Published when the state change
is first seen on a node.
|
| ClusterEventMemberExited |
This class represents a ClusterEventMemberStatusChange event where the
cluster node changed its status to Exiting.
The node is removed when all members have seen the Exiting status.
|
| ClusterEventMemberJoined |
This class represents a ClusterEventMemberStatusChange event where the
cluster node changed its status to Joining.
|
| ClusterEventMemberLeft |
This class represents a ClusterEventMemberStatusChange event where the
cluster node changed its status to Leaving.
|
| ClusterEventMemberRemoved | This class represents a ClusterEventMemberStatusChange event where the cluster node changed its status to Removed. When PreviousStatus is Down the node was removed after being detected as unreachable and downed. When PreviousStatus is Exiting the node was removed after graceful leaving and exiting. |
| ClusterEventMemberStatusChange |
This class provides base functionality for defining state change events for cluster member nodes.
|
| ClusterEventMemberUp |
This class represents a ClusterEventMemberStatusChange event where the
cluster node changed its status to Up.
|
| ClusterEventReachabilityEvent |
TBD
|
| ClusterEventReachableMember |
A member is considered as reachable by the failure detector
after having been unreachable.
ClusterEventUnreachableMember |
| ClusterEventRoleLeaderChanged |
First member (leader) of the members within a role set changed.
Published when the state change is first seen on a node.
|
| ClusterEventUnreachableMember |
A member is considered as unreachable by the failure detector.
|
| ClusterExtension |
This class represents an ActorSystem provider used to create the cluster extension.
|
| ClusterScope |
This class represents a binding of an actor deployment to a cluster-aware system.
|
| ClusterSettings |
This class represents configuration information used when setting up a cluster.
|
| Member |
Represents the address, current status, and roles of a cluster member node.
|
| NoDowning |
Default downing provider used when no provider is configured and 'auto-down-unreachable-after'
is not enabled.
|
| UniqueAddress |
Member identifier consisting of address and random `uid`.
The `uid` is needed to be able to distinguish different
incarnations of a member with same hostname and port.
|
| VectorClock | Representation of a Vector-based clock (counting clock), inspired by Lamport logical clocks. Reference:
Based on code from the 'vlock' VectorClock library by Coda Hale. |
| VectorClockNode |
Hash representation of a versioned node name.
|
Interfaces| Interface | Description | |
|---|---|---|
 | ClusterEventIClusterDomainEvent |
Marker interface for cluster domain events
|
| ClusterEventIMemberEvent |
This interface marks a given class as a membership event.
The event is published when the state change is first seen on a node.
The state change was performed by the leader when there was
convergence on the leader node, i.e. all members had seen previous
state.
|
| ClusterEventIReachabilityEvent |
A marker interface to facilitate the subscription of
both ClusterEventUnreachableMember and ClusterEventReachableMember.
|
| IClusterMessage |
Base interface for all cluster messages. All ClusterMessage's are serializable.
|
| IDowningProvider |
API for plugins that will handle downing of cluster nodes. Concrete plugins must subclass and
have a public one argument constructor accepting an ActorSystem.
|
Enumerations| Enumeration | Description | |
|---|---|---|
 | ClusterEventSubscriptionInitialStateMode |
The mode for getting the current state of the cluster upon first subscribing.
|
| MemberStatus |
Defines the current status of a cluster member node
Can be one of: Joining, Up, Leaving, Exiting and Down.
|
| VectorClockOrdering |
Indicates the age of one VectorClock relative to another.
|