Class ClusterRouterGroup

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
Group
ClusterRouterGroup
Implements
Inherited Members
Namespace: Akka.Cluster.Routing
Assembly: Akka.Cluster.dll
Syntax
public sealed class ClusterRouterGroup : Group, ISurrogated, IEquatable<RouterConfig>, IEquatable<Group>

Constructors

| Edit this page View Source

ClusterRouterGroup(Group, ClusterRouterGroupSettings)

TBD

Declaration
public ClusterRouterGroup(Group local, ClusterRouterGroupSettings settings)
Parameters
Type Name Description
Group local

TBD
ClusterRouterGroupSettings settings

TBD

Properties

| Edit this page View Source

Local

TBD

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

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
| Edit this page View Source

Settings

TBD

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

StopRouterWhenAllRouteesRemoved

Specify that this router should stop itself when all routees have terminated (been removed). By Default it is true, unless a resizer is used.

Declaration
public override bool StopRouterWhenAllRouteesRemoved { get; }
Property Value
Type Description
bool
Overrides

Methods

| Edit this page View Source

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
| Edit this page View Source

CreateRouterActor()

The router "head" actor.

Declaration
public override ActorBase CreateRouterActor()
Returns
Type Description
ActorBase
Overrides
Remarks

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

Should only return Akka.Routing.RoutedActorRef types.

| Edit this page View Source

GetPaths(ActorSystem)

Retrieves the actor paths used by this router during routee selection.

Declaration
public override IEnumerable<string> GetPaths(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

The actor system that owns this router.
Returns
Type Description
IEnumerable<string>

An enumeration of actor paths used during routee selection
Overrides
| Edit this page View Source

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
| Edit this page View Source

RoutingLogicController(RoutingLogic)

TBD

Declaration
public override Props RoutingLogicController(RoutingLogic routingLogic)
Parameters
Type Name Description
RoutingLogic routingLogic

TBD
Returns
Type Description
Props

TBD
Overrides
| Edit this page View Source

ToSurrogate(ActorSystem)

Creates a surrogate representation of the current router.

Declaration
public override ISurrogate ToSurrogate(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

The actor system that owns this router.
Returns
Type Description
ISurrogate

The surrogate representation of the current router.
Overrides
| Edit this page View Source

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
Exceptions
Type Condition
ConfigurationException

This exception is thrown when the specified router is another ClusterRouterGroup. This configuration is not allowed.

Implements

Extension Methods