Class RemoteRouterConfig

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

Inheritance
object
RouterConfig
Pool
RemoteRouterConfig
Implements
Inherited Members
Namespace: Akka.Remote.Routing
Assembly: Akka.Remote.dll
Syntax
public sealed class RemoteRouterConfig : Pool, ISurrogated, IEquatable<Pool>, IEquatable<RouterConfig>

Constructors

| Edit this page View Source

RemoteRouterConfig(Pool, IEnumerable<Address>)

Initializes a new instance of the RemoteRouterConfig class.

Declaration
public RemoteRouterConfig(Pool local, IEnumerable<Address> nodes)
Parameters
Type Name Description
Pool local

TBD
IEnumerable<Address> nodes

TBD
Exceptions
Type Condition
ArgumentException

This exception is thrown when the enumeration of specified nodes is empty.

Properties

| Edit this page View Source

Resizer

Retrieve the resizer to use when dynamically allocating routees to the pool.

Declaration
public override Resizer Resizer { get; }
Property Value
Type Description
Resizer
Overrides
| 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

SupervisorStrategy

Retrieve the strategy to use when supervising the pool.

Declaration
public override SupervisorStrategy SupervisorStrategy { get; }
Property Value
Type Description
SupervisorStrategy
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

Equals(RouterConfig)

Determines whether the specified router, is equal to this instance.

Declaration
public bool Equals(RouterConfig other)
Parameters
Type Name Description
RouterConfig other

The group to compare.
Returns
Type Description
bool

true if the specified router is equal to this instance; otherwise, false.
| Edit this page View Source

GetNrOfInstances(ActorSystem)

TBD

Declaration
public override int GetNrOfInstances(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

TBD
Returns
Type Description
int

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)

Configures 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 RemoteRouterConfig. This configuration is not allowed.

Implements

Extension Methods