 | ClusterRouterGroup Class |
RouterConfig implementation for deployment on cluster nodes.
Delegates other duties to the local RouterConfig, which makes it
possible to mix this with built-in routers such as RoundRobinGroup or
custom routers.
Inheritance HierarchyNamespace: Akka.Cluster.Routing
Assembly: Akka.Cluster (in Akka.Cluster.dll) Version: 1.2.3.42 (1.2.3.42)
SyntaxThe ClusterRouterGroup type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ClusterRouterGroup |
TBD
|
Properties| Name | Description | |
|---|---|---|
 | Local |
TBD
|
| Paths |
TBD
(Inherited from Group.) |
| RouterDispatcher |
Dispatcher ID to use for running the "head" actor, which handles supervision, death watch and router management messages.
(Overrides RouterConfigRouterDispatcher.) |
| Settings |
TBD
|
| 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.
(Overrides RouterConfigStopRouterWhenAllRouteesRemoved.) |
Methods| Name | Description | |
|---|---|---|
| CreateRouter |
Creates a router that is responsible for routing messages to routees within the provided system.
(Overrides RouterConfigCreateRouter(ActorSystem).) |
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Group.) |
| Equals(Group) | Indicates whether the current object is equal to another object of the same type. (Inherited from Group.) |
| Equals(RouterConfig) | Indicates whether the current object is equal to another object of the same type. (Inherited from RouterConfig.) |
 | 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 Group.) |
| GetPaths |
Retrieves the actor paths used by this router during routee selection.
(Overrides GroupGetPaths(ActorSystem).) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsManagementMessage |
Determines whether a provided message is handled by the router.
(Overrides RouterConfigIsManagementMessage(Object).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Props |
Adds the current router to an empty Props.
(Inherited from Group.) |
| RoutingLogicController |
TBD
(Overrides RouterConfigRoutingLogicController(RoutingLogic).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToSurrogate |
Creates a surrogate representation of the current router.
(Overrides RouterConfigToSurrogate(ActorSystem).) |
| VerifyConfig |
Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.
(Inherited from RouterConfig.) |
| WithFallback |
Configure the current router with an auxiliary router for routes that it does not know how to handle.
(Overrides RouterConfigWithFallback(RouterConfig).) |
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.) |
See Also