Class ClusterRouterPoolSettings

TotalInstances of cluster router must be > 0 MaxInstancesPerNode of cluster router must be > 0 MaxInstancesPerNode of cluster router must be 1 when routeesPath is defined

Inheritance
object
ClusterRouterSettingsBase
ClusterRouterPoolSettings
Inherited Members
Namespace: Akka.Cluster.Routing
Assembly: Akka.Cluster.dll
Syntax
public sealed class ClusterRouterPoolSettings : ClusterRouterSettingsBase

Constructors

| Edit this page View Source

ClusterRouterPoolSettings(int, int, bool, string)

Initializes a new instance of the ClusterRouterPoolSettings class.

Declaration
public ClusterRouterPoolSettings(int totalInstances, int maxInstancesPerNode, bool allowLocalRoutees, string useRole = null)
Parameters
Type Name Description
int totalInstances

TBD
int maxInstancesPerNode

TBD
bool allowLocalRoutees

TBD
string useRole

TBD
Exceptions
Type Condition
ArgumentOutOfRangeException

This exception is thrown when the specified maxInstancesPerNode is less than or equal to zero.

Properties

| Edit this page View Source

MaxInstancesPerNode

The maximum number of routee actors that can be deployed per valid node.

Declaration
public int MaxInstancesPerNode { get; }
Property Value
Type Description
int

Methods

| Edit this page View Source

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides
| Edit this page View Source

FromConfig(Config)

Creates a new ClusterRouterPoolSettings from the specified configuration.

Declaration
public static ClusterRouterPoolSettings FromConfig(Config config)
Parameters
Type Name Description
Config config

The configuration used to configure the settings.
Returns
Type Description
ClusterRouterPoolSettings

New settings based on the specified config
| Edit this page View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

Extension Methods