Search Results for

    Show / Hide Table of Contents

    Class RouterConfig

    This class provides base functionality used in the creation and configuration of the various routers in the system.

    Inheritance
    object
    RouterConfig
    CustomRouterConfig
    Group
    NoRouter
    Pool
    Implements
    ISurrogated
    IEquatable<RouterConfig>
    Inherited Members
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Akka.Routing
    Assembly: Akka.dll
    Syntax
    public abstract class RouterConfig : ISurrogated, IEquatable<RouterConfig>

    Constructors

    | Edit this page View Source

    RouterConfig()

    Initializes a new instance of the RouterConfig class.

    Declaration
    protected RouterConfig()
    | Edit this page View Source

    RouterConfig(string)

    Initializes a new instance of the RouterConfig class.

    note

    This method defaults to setting the dispatcher to use the DefaultDispatcherId.

    Declaration
    protected RouterConfig(string routerDispatcher)
    Parameters
    Type Name Description
    string routerDispatcher

    The dispatcher to use when passing messages to routees.

    Properties

    | 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 virtual string RouterDispatcher { get; }
    Property Value
    Type Description
    string
    | 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 virtual bool StopRouterWhenAllRouteesRemoved { get; }
    Property Value
    Type Description
    bool

    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 abstract 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.

    | Edit this page View Source

    Equals(RouterConfig)

    Declaration
    public bool Equals(RouterConfig other)
    Parameters
    Type Name Description
    RouterConfig other
    Returns
    Type Description
    bool
    | Edit this page View Source

    Equals(object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj
    Returns
    Type Description
    bool
    Overrides
    object.Equals(object)
    | Edit this page View Source

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    Overrides
    object.GetHashCode()
    | Edit this page View Source

    IsManagementMessage(object)

    Determines whether a provided message is handled by the router.

    Declaration
    public virtual 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.

    | Edit this page View Source

    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 virtual Props RoutingLogicController(RoutingLogic routingLogic)
    Parameters
    Type Name Description
    RoutingLogic routingLogic
    Returns
    Type Description
    Props
    | Edit this page View Source

    ToSurrogate(ActorSystem)

    Creates a surrogate representation of the current router.

    Declaration
    public abstract 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.

    | Edit this page View Source

    VerifyConfig(ActorPath)

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

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

    TBD

    | 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 virtual 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.

    Implements

    ISurrogated
    IEquatable<T>

    Extension Methods

    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    Extensions.AsInstanceOf<T>(object)
    In this article
    • githubEdit this page
    • View Source
    Back to top
    Contribute
    • Project Chat
    • Discussion Forum
    • Source Code
    Support
    • Akka.NET Support Plans
    • Akka.NET Observability Tools
    • Akka.NET Training & Consulting
    Maintained By
    • Petabridge - The Akka.NET Company
    • Learn Akka.NET