Class ClusterEvent.CurrentClusterState

A snapshot of the current state of the Cluster

Inheritance

Object

ClusterEvent.CurrentClusterState

Implements

INoSerializationVerificationNeeded

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.Cluster

Assembly: Akka.Cluster.dll

Syntax

public sealed class CurrentClusterState : INoSerializationVerificationNeeded

Constructors

CurrentClusterState()

Creates a new instance of the current cluster state.

Declaration

public CurrentClusterState()

CurrentClusterState(ImmutableSortedSet<Member>, ImmutableHashSet<Member>, ImmutableHashSet<Address>, Address, ImmutableDictionary<String, Address>)

Creates a new instance of the current cluster state.

Declaration

public CurrentClusterState(ImmutableSortedSet<Member> members, ImmutableHashSet<Member> unreachable, ImmutableHashSet<Address> seenBy, Address leader, ImmutableDictionary<string, Address> roleLeaderMap)

Parameters

Type	Name	Description
System.Collections.Immutable.ImmutableSortedSet<Member>	members	The current members of the cluster.
System.Collections.Immutable.ImmutableHashSet<Member>	unreachable	The unreachable members of the cluster.
System.Collections.Immutable.ImmutableHashSet<Address>	seenBy	The set of nodes who have seen us.
Address	leader	The leader of the cluster.
System.Collections.Immutable.ImmutableDictionary<String, Address>	roleLeaderMap	The list of role leaders.

Properties

AllRoles

All node roles in the cluster

Declaration

public ImmutableHashSet<string> AllRoles { get; }

Property Value

Type	Description
System.Collections.Immutable.ImmutableHashSet<String>

HasMoreThanOneAppVersion

return true if more than one Version among the members, which indicates that a rolling update is in progress

Declaration

public bool HasMoreThanOneAppVersion { get; }

Property Value

Type	Description
Boolean

Leader

Get address of current leader, or null if noe

Declaration

public Address Leader { get; }

Property Value

Type	Description
Address

Members

Get current member list

Declaration

public ImmutableSortedSet<Member> Members { get; }

Property Value

Type	Description
System.Collections.Immutable.ImmutableSortedSet<Member>

SeenBy

Get current "seen-by" set

Declaration

public ImmutableHashSet<Address> SeenBy { get; }

Property Value

Type	Description
System.Collections.Immutable.ImmutableHashSet<Address>

Unreachable

Get current unreachable set

Declaration

public ImmutableHashSet<Member> Unreachable { get; }

Property Value

Type	Description
System.Collections.Immutable.ImmutableHashSet<Member>

Methods

Copy(ImmutableSortedSet<Member>, ImmutableHashSet<Member>, ImmutableHashSet<Address>, Address, ImmutableDictionary<String, Address>)

Creates a deep copy of the ClusterEvent.CurrentClusterState and optionally allows you to specify different values for the outgoing objects

Declaration

public ClusterEvent.CurrentClusterState Copy(ImmutableSortedSet<Member> members = null, ImmutableHashSet<Member> unreachable = null, ImmutableHashSet<Address> seenBy = null, Address leader = null, ImmutableDictionary<string, Address> roleLeaderMap = null)

Parameters

Type	Name	Description
System.Collections.Immutable.ImmutableSortedSet<Member>	members	TBD
System.Collections.Immutable.ImmutableHashSet<Member>	unreachable	TBD
System.Collections.Immutable.ImmutableHashSet<Address>	seenBy	TBD
Address	leader	TBD
System.Collections.Immutable.ImmutableDictionary<String, Address>	roleLeaderMap	TBD

Returns

Type	Description
ClusterEvent.CurrentClusterState	TBD

RoleLeader(String)

Get address of current leader, if any, within the role set

Declaration

public Address RoleLeader(string role)

Parameters

Type	Name	Description
String	role	The role we wish to check.

Returns

Type	Description
Address	The address of the node who is the real leader, if any. Otherwise null.

Implements

INoSerializationVerificationNeeded

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)