Class ScatterGatherFirstCompletedPool

This class represents a Pool 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

Object

RouterConfig

Pool

ScatterGatherFirstCompletedPool

Implements

ISurrogated

IEquatable<RouterConfig>

IEquatable<Pool>

Inherited Members

Pool.NrOfInstances

Pool.UsePoolDispatcher

Pool.Resizer

Pool.SupervisorStrategy

Pool.Props(Props)

Pool.StopRouterWhenAllRouteesRemoved

Pool.CreateRouterActor()

Pool.DefaultSupervisorStrategy

Pool.Equals(Pool)

Pool.Equals(Object)

Pool.GetHashCode()

RouterConfig.RouterDispatcher

RouterConfig.RoutingLogicController(RoutingLogic)

RouterConfig.IsManagementMessage(Object)

RouterConfig.VerifyConfig(ActorPath)

RouterConfig.Equals(RouterConfig)

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.Routing

Assembly: Akka.dll

Syntax

public sealed class ScatterGatherFirstCompletedPool : Pool, ISurrogated, IEquatable<RouterConfig>, IEquatable<Pool>

Constructors

| Improve this Doc View Source

ScatterGatherFirstCompletedPool(Config)

Initializes a new instance of the ScatterGatherFirstCompletedPool class.

Declaration

public ScatterGatherFirstCompletedPool(Config config)

Parameters

Type	Name	Description
Config	config	The configuration to use to lookup paths used by the group router. note 'within' must be defined in the provided configuration.

| Improve this Doc View Source

ScatterGatherFirstCompletedPool(Int32)

Initializes a new instance of the ScatterGatherFirstCompletedPool class.

note

A ScatterGatherFirstCompletedPool configured in this way uses the DefaultSupervisorStrategy supervisor strategy.

Declaration

public ScatterGatherFirstCompletedPool(int nrOfInstances)

Parameters

Type	Name	Description
Int32	nrOfInstances	The initial number of routees in the pool.

| Improve this Doc View Source

ScatterGatherFirstCompletedPool(Int32, Resizer, TimeSpan, SupervisorStrategy, String, Boolean)

Initializes a new instance of the ScatterGatherFirstCompletedPool class.

Declaration

public ScatterGatherFirstCompletedPool(int nrOfInstances, Resizer resizer, TimeSpan within, SupervisorStrategy supervisorStrategy, string routerDispatcher, bool usePoolDispatcher = false)

Parameters

Type	Name	Description
Int32	nrOfInstances	The initial number of routees in the pool.
Resizer	resizer	The resizer to use when dynamically allocating routees to the pool.
TimeSpan	within	The amount of time to wait for a response.
SupervisorStrategy	supervisorStrategy	The strategy to use when supervising the pool.
String	routerDispatcher	The dispatcher to use when passing messages to the routees.
Boolean	usePoolDispatcher	`true` to use the pool dispatcher; otherwise `false`.

| Improve this Doc View Source

ScatterGatherFirstCompletedPool(Int32, TimeSpan)

Initializes a new instance of the ScatterGatherFirstCompletedPool class.

Declaration

public ScatterGatherFirstCompletedPool(int nrOfInstances, TimeSpan within)

Parameters

Type	Name	Description
Int32	nrOfInstances	The initial number of routees in the pool.
TimeSpan	within	The amount of time to wait for a response.

Properties

| Improve this Doc View Source

Within

The amount of time to wait for a response.

Declaration

public TimeSpan Within { get; }

Property Value

Type	Description
TimeSpan

Methods

| Improve this Doc View Source

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 actor system that owns this router.

Returns

Type	Description
Router	The newly created router tied to the given system.

Overrides

RouterConfig.CreateRouter(ActorSystem)

| Improve this Doc View Source

GetNrOfInstances(ActorSystem)

Used by the Akka.Routing.RoutedActorCell to determine the initial number of routees.

Declaration

public override int GetNrOfInstances(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	The actor system that owns this router.

Returns

Type	Description
Int32	The number of routees associated with this pool.

Overrides

Pool.GetNrOfInstances(ActorSystem)

| Improve this Doc View Source

ToSurrogate(ActorSystem)

Creates a surrogate representation of the current ScatterGatherFirstCompletedPool.

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

Overrides

RouterConfig.ToSurrogate(ActorSystem)

| Improve this Doc View Source

WithDispatcher(String)

Creates a new ScatterGatherFirstCompletedPool router with a given dispatcher id.

note

This method is immutable and returns a new instance of the router.

Declaration

public ScatterGatherFirstCompletedPool WithDispatcher(string dispatcher)

Parameters

Type	Name	Description
String	dispatcher	The dispatcher id used to configure the new router.

Returns

Type	Description
ScatterGatherFirstCompletedPool	A new router with the provided dispatcher id.

| Improve this Doc View Source

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

RouterConfig.WithFallback(RouterConfig)

| Improve this Doc View Source

WithResizer(Resizer)

Creates a new ScatterGatherFirstCompletedPool router with a given Resizer.

note

This method is immutable and returns a new instance of the router.

Declaration

public ScatterGatherFirstCompletedPool WithResizer(Resizer resizer)

Parameters

Type	Name	Description
Resizer	resizer	The Resizer used to configure the new router.

Returns

Type	Description
ScatterGatherFirstCompletedPool	A new router with the provided `resizer`.

| Improve this Doc View Source

WithSupervisorStrategy(SupervisorStrategy)

Creates a new ScatterGatherFirstCompletedPool router with a given SupervisorStrategy.

note

This method is immutable and returns a new instance of the router.

Declaration

public ScatterGatherFirstCompletedPool WithSupervisorStrategy(SupervisorStrategy strategy)

Parameters

Type	Name	Description
SupervisorStrategy	strategy	The SupervisorStrategy used to configure the new router.

Returns

Type	Description
ScatterGatherFirstCompletedPool	A new router with the provided `strategy`.

Implements

ISurrogated

IEquatable<T>

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)