Class ClusterRouterPool

RouterConfig implementation for deployment on cluster nodes. Delegates other duties to the local RouterConfig, which makes it possible to mix this with built-in routers such as RoundRobinGroup or custom routers.

Inheritance

object

RouterConfig

Pool

ClusterRouterPool

Implements

ISurrogated

IEquatable<RouterConfig>

IEquatable<Pool>

Inherited Members

Pool.NrOfInstances

Pool.UsePoolDispatcher

Pool.Resizer

Pool.Props(Props)

Pool.DefaultSupervisorStrategy

Pool.Equals(Pool)

Pool.Equals(object)

Pool.GetHashCode()

RouterConfig.VerifyConfig(ActorPath)

RouterConfig.Equals(RouterConfig)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Cluster.Routing

Assembly: Akka.Cluster.dll

Syntax

public sealed class ClusterRouterPool : Pool, ISurrogated, IEquatable<RouterConfig>, IEquatable<Pool>

Constructors

ClusterRouterPool(Pool, ClusterRouterPoolSettings)

Initializes a new instance of the ClusterRouterPool class.

Declaration

public ClusterRouterPool(Pool local, ClusterRouterPoolSettings settings)

Parameters

Type	Name	Description
Pool	local	TBD
ClusterRouterPoolSettings	settings	TBD

Exceptions

Type	Condition
ConfigurationException	This exception is thrown when the resizer in the specified pool local is defined. A resizer cannot be used in conjunction with a cluster router.

Properties

Local

TBD

Declaration

public Pool Local { get; }

Property Value

Type	Description
Pool

RouterDispatcher

Dispatcher ID to use for running the "head" actor, which handles supervision, death watch and router management messages.

Declaration

public override string RouterDispatcher { get; }

Property Value

Type	Description
string

Overrides

RouterConfig.RouterDispatcher

Settings

TBD

Declaration

public ClusterRouterPoolSettings Settings { get; }

Property Value

Type	Description
ClusterRouterPoolSettings

StopRouterWhenAllRouteesRemoved

Specify that this router should stop itself when all routees have terminated (been removed).

Declaration

public override bool StopRouterWhenAllRouteesRemoved { get; }

Property Value

Type	Description
bool

Overrides

Pool.StopRouterWhenAllRouteesRemoved

SupervisorStrategy

Retrieve the strategy to use when supervising the pool.

Declaration

public override SupervisorStrategy SupervisorStrategy { get; }

Property Value

Type	Description
SupervisorStrategy

Overrides

Pool.SupervisorStrategy

Methods

CreateRouter(ActorSystem)

Creates a router that is responsible for routing messages to routees within the provided system.

Declaration

public override Router CreateRouter(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	The ActorSystem this router belongs to.

Returns

Type	Description
Router	The newly created router tied to the given system.

Overrides

RouterConfig.CreateRouter(ActorSystem)

CreateRouterActor()

The router "head" actor.

Declaration

public override ActorBase CreateRouterActor()

Returns

Type	Description
ActorBase

Overrides

Pool.CreateRouterActor()

Remarks

WARNING: make sure you know what you're doing before you attempt to implement this method.

Should only return Akka.Routing.RoutedActorRef types.

GetNrOfInstances(ActorSystem)

Returns the initial number of routees

Declaration

public override int GetNrOfInstances(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	The actor system to which this router belongs.

Returns

Type	Description
int	The initial number of routees

Overrides

Pool.GetNrOfInstances(ActorSystem)

IsManagementMessage(object)

Determines whether a provided message is handled by the router.

Declaration

public override bool IsManagementMessage(object message)

Parameters

Type	Name	Description
object	message	The message to inspect.

Returns

Type	Description
bool	true if this message is handled by the router; otherwise false.

Overrides

RouterConfig.IsManagementMessage(object)

RoutingLogicController(RoutingLogic)

TBD

Declaration

public override Props RoutingLogicController(RoutingLogic routingLogic)

Parameters

Type	Name	Description
RoutingLogic	routingLogic	TBD

Returns

Type	Description
Props	TBD

Overrides

RouterConfig.RoutingLogicController(RoutingLogic)

ToSurrogate(ActorSystem)

N/A

Declaration

public override ISurrogate ToSurrogate(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	N/A

Returns

Type	Description
ISurrogate	N/A

Overrides

RouterConfig.ToSurrogate(ActorSystem)

Exceptions

Type	Condition
NotImplementedException	This exception is thrown automatically since surrogates aren't supported by this router.

WithFallback(RouterConfig)

Configure the current router with an auxiliary router for routes that it does not know how to handle.

Declaration

public override RouterConfig WithFallback(RouterConfig routerConfig)

Parameters

Type	Name	Description
RouterConfig	routerConfig	The router to use as an auxiliary source.

Returns

Type	Description
RouterConfig	The router configured with the auxiliary information.

Overrides

RouterConfig.WithFallback(RouterConfig)

Exceptions

Type	Condition
ConfigurationException	This exception is thrown when the specified router is another ClusterRouterPool. This configuration is not allowed.

Implements

ISurrogated

IEquatable<T>

IEquatable<T>

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)