Class MultiNodeClusterSpec

Inheritance
object
TestKitBase
MultiNodeSpec
MultiNodeClusterSpec
Implements
Inherited Members
Namespace: Akka.Cluster.TestKit
Assembly: Akka.Cluster.TestKit.dll
Syntax
public abstract class MultiNodeClusterSpec : MultiNodeSpec, IActorRefFactory, IMultiNodeSpecCallbacks, IDisposable

Constructors

| Edit this page View Source

MultiNodeClusterSpec(MultiNodeConfig, Type)

Declaration
protected MultiNodeClusterSpec(MultiNodeConfig config, Type type)
Parameters
Type Name Description
MultiNodeConfig config
Type type
| Edit this page View Source

MultiNodeClusterSpec(RoleName, ActorSystem, ImmutableList<RoleName>, Func<RoleName, ImmutableList<string>>)

Declaration
protected MultiNodeClusterSpec(RoleName myself, ActorSystem system, ImmutableList<RoleName> roles, Func<RoleName, ImmutableList<string>> deployments)
Parameters
Type Name Description
RoleName myself
ActorSystem system
ImmutableList<RoleName> roles
Func<RoleName, ImmutableList<string>> deployments
| Edit this page View Source

MultiNodeClusterSpec(RoleName, ActorSystemSetup, ImmutableList<RoleName>, Func<RoleName, ImmutableList<string>>)

Declaration
protected MultiNodeClusterSpec(RoleName myself, ActorSystemSetup setup, ImmutableList<RoleName> roles, Func<RoleName, ImmutableList<string>> deployments)
Parameters
Type Name Description
RoleName myself
ActorSystemSetup setup
ImmutableList<RoleName> roles
Func<RoleName, ImmutableList<string>> deployments

Properties

| Edit this page View Source

Cluster

Get the cluster node to use.

Declaration
public Cluster Cluster { get; }
Property Value
Type Description
Cluster
| Edit this page View Source

InitialParticipantsValueFactory

Must be defined by user. Creates the values used by InitialParticipants

Declaration
protected override int InitialParticipantsValueFactory { get; }
Property Value
Type Description
int
Overrides

Methods

| Edit this page View Source

AfterTermination()

Override this method to do something when the whole test is terminating.

Declaration
protected override void AfterTermination()
Overrides
| Edit this page View Source

AssertLeader(params RoleName[])

Note that this can only be used for a cluster with all members in Up status, i.e. use awaitMembersUp before using this method. The reason for that is that the cluster leader is preferably a member with status Up or Leaving and that information can't be determined from the RoleName.

Declaration
public void AssertLeader(params RoleName[] nodesInCluster)
Parameters
Type Name Description
RoleName[] nodesInCluster
| Edit this page View Source

AssertLeaderIn(ImmutableList<RoleName>)

Assert that the cluster has elected the correct leader out of all nodes in the cluster. First member in the cluster ring is expected leader.

Note that this can only be used for a cluster with all members in Up status, i.e. use awaitMembersUp before using this method. The reason for that is that the cluster leader is preferably a member with status Up or Leaving and that information can't be determined from the RoleName.

Declaration
public void AssertLeaderIn(ImmutableList<RoleName> nodesInCluster)
Parameters
Type Name Description
ImmutableList<RoleName> nodesInCluster
| Edit this page View Source

AssertMembers(IEnumerable<Member>, params Address[])

Assert that the member addresses match the expected addresses in the sort order used by the cluster.

Declaration
public void AssertMembers(IEnumerable<Member> gotMembers, params Address[] expectedAddresses)
Parameters
Type Name Description
IEnumerable<Member> gotMembers
Address[] expectedAddresses
| Edit this page View Source

AtStartup()

Override this method to do something when the whole test is starting up.

Declaration
protected override void AtStartup()
Overrides
| Edit this page View Source

AwaitAllReachable()

Declaration
public void AwaitAllReachable()
| Edit this page View Source

AwaitAllReachableAsync()

Declaration
public Task AwaitAllReachableAsync()
Returns
Type Description
Task
| Edit this page View Source

AwaitClusterUp(params RoleName[])

Initialize the cluster of the specified member nodes (roles) and wait until all joined and Up.

First node will be started first and others will join the first.

Declaration
public void AwaitClusterUp(params RoleName[] roles)
Parameters
Type Name Description
RoleName[] roles
| Edit this page View Source

AwaitClusterUpAsync(CancellationToken, params RoleName[])

Initialize the cluster of the specified member nodes (roles) and wait until all joined and Up.

First node will be started first and others will join the first.

Declaration
public Task AwaitClusterUpAsync(CancellationToken cancellationToken, params RoleName[] roles)
Parameters
Type Name Description
CancellationToken cancellationToken
RoleName[] roles
Returns
Type Description
Task
| Edit this page View Source

AwaitMembersUp(int, ImmutableHashSet<Address>, TimeSpan?)

Declaration
public void AwaitMembersUp(int numbersOfMembers, ImmutableHashSet<Address> canNotBePartOfMemberRing = null, TimeSpan? timeout = null)
Parameters
Type Name Description
int numbersOfMembers
ImmutableHashSet<Address> canNotBePartOfMemberRing
TimeSpan? timeout
| Edit this page View Source

AwaitMembersUpAsync(int, ImmutableHashSet<Address>, TimeSpan?, CancellationToken)

Declaration
public Task AwaitMembersUpAsync(int numbersOfMembers, ImmutableHashSet<Address> canNotBePartOfMemberRing = null, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int numbersOfMembers
ImmutableHashSet<Address> canNotBePartOfMemberRing
TimeSpan? timeout
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

AwaitSeenSameState(params Address[])

Declaration
public void AwaitSeenSameState(params Address[] addresses)
Parameters
Type Name Description
Address[] addresses
| Edit this page View Source

AwaitSeenSameStateAsync(CancellationToken, params Address[])

Declaration
public Task AwaitSeenSameStateAsync(CancellationToken cancellationToken, params Address[] addresses)
Parameters
Type Name Description
CancellationToken cancellationToken
Address[] addresses
Returns
Type Description
Task
| Edit this page View Source

ClusterConfig()

Declaration
public static Config ClusterConfig()
Returns
Type Description
Config
| Edit this page View Source

ClusterConfig(bool)

Declaration
public static Config ClusterConfig(bool failureDetectorPuppet)
Parameters
Type Name Description
bool failureDetectorPuppet
Returns
Type Description
Config
| Edit this page View Source

ClusterConfigWithFailureDetectorPuppet()

Declaration
public static Config ClusterConfigWithFailureDetectorPuppet()
Returns
Type Description
Config
| Edit this page View Source

FailureDetectorPuppet(Address)

Declaration
public FailureDetectorPuppet FailureDetectorPuppet(Address address)
Parameters
Type Name Description
Address address
Returns
Type Description
FailureDetectorPuppet
| Edit this page View Source

GetAddress(RoleName)

Declaration
public Address GetAddress(RoleName role)
Parameters
Type Name Description
RoleName role
Returns
Type Description
Address
| Edit this page View Source

IsFailureDetectorPuppet()

Declaration
public bool IsFailureDetectorPuppet()
Returns
Type Description
bool
| Edit this page View Source

JoinWithin(RoleName, TimeSpan?, TimeSpan?)

Declaration
public void JoinWithin(RoleName joinNode, TimeSpan? max = null, TimeSpan? interval = null)
Parameters
Type Name Description
RoleName joinNode
TimeSpan? max
TimeSpan? interval
| Edit this page View Source

MarkNodeAsAvailable(Address)

Marks a node as available in the failure detector if FailureDetectorPuppet(Address) is used as failure detector

Declaration
public void MarkNodeAsAvailable(Address address)
Parameters
Type Name Description
Address address
| Edit this page View Source

MarkNodeAsUnavailable(Address)

Marks a node as unavailable in the failure detector if FailureDetectorPuppet(Address) is used as failure detector

Declaration
public void MarkNodeAsUnavailable(Address address)
Parameters
Type Name Description
Address address
| Edit this page View Source

MuteLog(ActorSystem)

Declaration
public virtual void MuteLog(ActorSystem sys = null)
Parameters
Type Name Description
ActorSystem sys
| Edit this page View Source

MuteMarkingAsReachable(ActorSystem)

Declaration
protected void MuteMarkingAsReachable(ActorSystem system = null)
Parameters
Type Name Description
ActorSystem system
| Edit this page View Source

MuteMarkingAsUnreachable(ActorSystem)

Declaration
protected void MuteMarkingAsUnreachable(ActorSystem system = null)
Parameters
Type Name Description
ActorSystem system
| Edit this page View Source

RoleName(Address)

Declaration
public RoleName RoleName(Address addr)
Parameters
Type Name Description
Address addr
Returns
Type Description
RoleName
| Edit this page View Source

RoleOfLeader(ImmutableList<RoleName>)

Leader according to the address ordering of the roles. Note that this can only be used for a cluster with all members in Up status, i.e. use awaitMembersUp before using this method. The reason for that is that the cluster leader is preferably a member with status Up or Leaving and that information can't be determined from the RoleName.

Declaration
public RoleName RoleOfLeader(ImmutableList<RoleName> nodesInCluster)
Parameters
Type Name Description
ImmutableList<RoleName> nodesInCluster
Returns
Type Description
RoleName
| Edit this page View Source

StartClusterNode()

Use this method for the initial startup of the cluster node

Declaration
public void StartClusterNode()
| Edit this page View Source

StartClusterNodeAsync(CancellationToken)

Use this method for the initial startup of the cluster node

Declaration
public Task StartClusterNodeAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

Implements

Extension Methods