Class ClusterRouterGroupSettings

TotalInstances of cluster router must be > 0

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

Constructors

| Improve this Doc View Source

ClusterRouterGroupSettings(Int32, IEnumerable<String>, Boolean, String)

Initializes a new instance of the ClusterRouterGroupSettings class.

Declaration
public ClusterRouterGroupSettings(int totalInstances, IEnumerable<string> routeesPaths, bool allowLocalRoutees, string useRole = null)
Parameters
Type Name Description
Int32 totalInstances

The total number of routees. Defaults to 10000.
IEnumerable<String> routeesPaths

The actor selection paths to use for each routee.
Boolean allowLocalRoutees

When true, allows routees to be deployed locally on the node doing the deploying so long as that node also satisfies the useRole setting when used.
String useRole

The role of the node upon which we are able to create routees.
Exceptions
Type Condition
ArgumentException

This exception is thrown when either the specified routeesPaths is undefined or a path defined in the specified routeesPaths is an invalid relative actor path.

Properties

| Improve this Doc View Source

RouteesPaths

The paths of the routees to use on each qualified node.

Declaration
public IEnumerable<string> RouteesPaths { get; }
Property Value
Type Description
IEnumerable<String>

Methods

| Improve this Doc View Source

FromConfig(Config)

Creates a new ClusterRouterGroupSettings from the specified configuration.

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

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

New settings based on the specified config

Extension Methods