RouterConfig Class

RouterConfig Class

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

Inheritance Hierarchy

Namespace: Akka.Routing
Assembly: Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)

Syntax

public abstract class RouterConfig : ISurrogated, 
	IEquatable<RouterConfig>

[<AbstractClassAttribute>]
type RouterConfig =  
    class
        interface ISurrogated
        interface IEquatable<RouterConfig>
    end

The RouterConfig type exposes the following members.

Constructors

Name

Description

Initializes a new instance of the RouterConfig class.

Initializes a new instance of the RouterConfig class.

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

Properties

	Name	Description
	NoRouter	Obsolete. A configuration that specifies that no router is to be used.
	RouterDispatcher	Dispatcher ID to use for running the "head" actor, which handles supervision, death watch and router management messages.
	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.

Methods

	Name	Description
	CreateRouter	Creates a router that is responsible for routing messages to routees within the provided system.
	Equals(Object)	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).)
	Equals(RouterConfig)	Indicates whether the current object is equal to another object of the same type.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsManagementMessage	Determines whether a provided message is handled by the router.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RoutingLogicController	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.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ToSurrogate	Creates a surrogate representation of the current router.
	VerifyConfig	Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.
	WithFallback	Configure the current router with an auxiliary router for routes that it does not know how to handle.

Extension Methods

	Name	Description
	AsInstanceOfT	TBD (Defined by Extensions.)
	Match	Overloaded. Matches the specified target. (Defined by PatternMatch.)
	MatchT	Overloaded. Matches the specified target and return a result of target processing. (Defined by PatternMatch.)