Class PhobosGroupRouterConfig

Used to wrap a Group such that any SpanEnvelopes are automatically unpacked prior to being considered for routing purposes.

Inheritance
object
RouterConfig
Group
PhobosGroupRouterConfig
Implements
Inherited Members
Namespace: Phobos.Actor.Routing
Assembly: Phobos.Actor.dll
Syntax
public sealed class PhobosGroupRouterConfig : Group, ISurrogated, IEquatable<RouterConfig>, IEquatable<Group>

Constructors

PhobosGroupRouterConfig(Group, IEnumerable<string>)

Declaration
public PhobosGroupRouterConfig(Group wrappedConfig, IEnumerable<string> paths)
Parameters
Type Name Description
Group wrappedConfig
IEnumerable<string> paths

Properties

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

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

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

CreateRouterActor()

TBD

Declaration
public override ActorBase CreateRouterActor()
Returns
Type Description
ActorBase

TBD
Overrides

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

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

RoutingLogicController(RoutingLogic)

Possibility to define an actor for controlling the routing logic from external stimuli(e.g.monitoring metrics). This actor will be a child of the router "head" actor. Management messages not handled by the "head" actor are delegated to this controller actor.

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

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

VerifyConfig(ActorPath)

Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.

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

TBD
Overrides

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

Implements