Class FromConfig

Router configuration which has no default, i.e. external configuration is required. This can be used when the dispatcher to be used for the head Router needs to be configured

Inheritance
Object
RouterConfig
Pool
FromConfig
Implements
Inherited Members
Namespace: Akka.Routing
Assembly: Akka.dll
Syntax
public class FromConfig : Pool, ISurrogated, IEquatable<RouterConfig>, IEquatable<Pool>

Constructors

| Improve this Doc View Source

FromConfig()

Initializes a new instance of the FromConfig class.

Declaration
public FromConfig()
| Improve this Doc View Source

FromConfig(Resizer, SupervisorStrategy, String)

Initializes a new instance of the FromConfig class.

Declaration
public FromConfig(Resizer resizer, SupervisorStrategy supervisorStrategy, string routerDispatcher)
Parameters
Type Name Description
Resizer resizer

TBD
SupervisorStrategy supervisorStrategy

TBD
String routerDispatcher

TBD

Properties

| Improve this Doc View Source

Instance

Retrieves a RouterConfig based on what's stored in the configuration.

note

This router is set to use the default dispatcher DefaultDispatcherId.

Declaration
public static FromConfig Instance { get; }
Property Value
Type Description
FromConfig

Methods

| Improve this Doc View Source

CreateRouter(ActorSystem)

N/A

Declaration
public override Router CreateRouter(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

N/A
Returns
Type Description
Router

N/A
Overrides
Exceptions
Type Condition
NotSupportedException

This exception is automatically thrown since FromConfig cannot create routers.
| Improve this Doc View Source

CreateRouterActor()

N/A

Declaration
public override ActorBase CreateRouterActor()
Returns
Type Description
ActorBase

N/A
Overrides
Exceptions
Type Condition
NotSupportedException

This exception is automatically thrown since FromConfig cannot create router actors.
| Improve this Doc View Source

GetNrOfInstances(ActorSystem)

TBD

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

TBD
Returns
Type Description
Int32

TBD
Overrides
| Improve this Doc View Source

Props()

Enriches a Props with what what's stored in the router configuration.

Declaration
public Props Props()
Returns
Type Description
Props

TBD
| Improve this Doc View Source

ToSurrogate(ActorSystem)

Creates a surrogate representation of the current FromConfig.

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 FromConfig.
Overrides
| Improve this Doc View Source

VerifyConfig(ActorPath)

N/A

Declaration
public override void VerifyConfig(ActorPath path)
Parameters
Type Name Description
ActorPath path

N/A
Overrides
Exceptions
Type Condition
ConfigurationException

This exception is automatically thrown since 'akka.actor.dispatch' is missing router configuration for path.
| Improve this Doc View Source

WithDispatcher(String)

Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.

Declaration
public FromConfig WithDispatcher(string dispatcherId)
Parameters
Type Name Description
String dispatcherId

TBD
Returns
Type Description
FromConfig

TBD
| Improve this Doc View Source

WithResizer(Resizer)

Setting the resizer to be used.

Declaration
public FromConfig WithResizer(Resizer resizer)
Parameters
Type Name Description
Resizer resizer

TBD
Returns
Type Description
FromConfig

TBD
| Improve this Doc View Source

WithSupervisorStrategy(SupervisorStrategy)

Setting the supervisor strategy to be used for the "head" Router actor

Declaration
public FromConfig WithSupervisorStrategy(SupervisorStrategy strategy)
Parameters
Type Name Description
SupervisorStrategy strategy

TBD
Returns
Type Description
FromConfig

TBD

Implements

Extension Methods