 | ScatterGatherFirstCompletedGroup Class |
This class represents a Group router that sends messages to a Routee determined using scatter-gather-first-completed.
This process has the router send a message to all of its routees. The first response is used and the remaining are discarded. If the none of the
routees respond within a specified time limit, a timeout failure occurs.
Inheritance HierarchySystemObject
Akka.RoutingRouterConfig
Akka.RoutingGroup
Akka.RoutingScatterGatherFirstCompletedGroup
Akka.RoutingRouterConfig
Akka.RoutingGroup
Akka.RoutingScatterGatherFirstCompletedGroup
Namespace: Akka.Routing
Assembly: Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)
SyntaxThe ScatterGatherFirstCompletedGroup type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ScatterGatherFirstCompletedGroup(Config) |
Initializes a new instance of the ScatterGatherFirstCompletedGroup class.
|
| ScatterGatherFirstCompletedGroup(IEnumerableString, TimeSpan) |
Initializes a new instance of the ScatterGatherFirstCompletedGroup class.
|
| ScatterGatherFirstCompletedGroup(TimeSpan, String) |
Initializes a new instance of the ScatterGatherFirstCompletedGroup class.
|
| ScatterGatherFirstCompletedGroup(IEnumerableIActorRef, TimeSpan) | Obsolete.
Obsolete. Use ScatterGatherFirstCompletedGroup(IEnumerableString, TimeSpan) instead.
new ScatterGatherFirstCompletedGroup(actorRefs.Select(c => c.Path.ToString()), within) |
| ScatterGatherFirstCompletedGroup(IEnumerableString, TimeSpan, String) |
Initializes a new instance of the ScatterGatherFirstCompletedGroup class.
|
Properties| Name | Description | |
|---|---|---|
 | Paths |
TBD
(Inherited from Group.) |
| RouterDispatcher |
Dispatcher ID to use for running the "head" actor, which handles supervision, death watch and router management messages.
(Inherited from RouterConfig.) |
| 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.
(Inherited from RouterConfig.) |
| Within |
The amount of time to wait for a response.
|
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.
(Inherited from RouterConfig.) | ||
| 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 |
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.
(Inherited from RouterConfig.) | ||
| ToString | Returns a string that represents the current object. (Inherited from Object.) | ||
| ToSurrogate |
Creates a surrogate representation of the current ScatterGatherFirstCompletedGroup.
(Overrides RouterConfigToSurrogate(ActorSystem).) | ||
| VerifyConfig |
Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.
(Inherited from RouterConfig.) | ||
| WithDispatcher |
Creates a new ScatterGatherFirstCompletedGroup router with a given dispatcher id.
| ||
| WithFallback |
Configure the current router with an auxiliary router for routes that it does not know how to handle.
(Inherited from RouterConfig.) |
NoteExtension 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