Class SmallestMailboxPool

This class represents a Pool router that sends messages to a Routee determined using smallest-mailbox. Please refer to SmallestMailboxRoutingLogic for more information on the selection process.

Inheritance

object

RouterConfig

Pool

SmallestMailboxPool

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.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Routing

Assembly: Akka.dll

Syntax

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

Constructors

SmallestMailboxPool(Config)

Initializes a new instance of the SmallestMailboxPool class.

Declaration

public SmallestMailboxPool(Config config)

Parameters

Type	Name	Description
Config	config	The configuration used to configure the pool.

SmallestMailboxPool(int)

Initializes a new instance of the SmallestMailboxPool class.

note

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

Declaration

public SmallestMailboxPool(int nrOfInstances)

Parameters

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

SmallestMailboxPool(int, Resizer, SupervisorStrategy, string, bool)

Initializes a new instance of the SmallestMailboxPool class.

Declaration

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

Parameters

Type	Name	Description
int	nrOfInstances	The initial number of routees in the pool.
Resizer	resizer	The resizer to use when dynamically allocating routees to the pool.
SupervisorStrategy	supervisorStrategy	The strategy to use when supervising the pool.
string	routerDispatcher	The dispatcher to use when passing messages to the routees.
bool	usePoolDispatcher	true to use the pool dispatcher; otherwise false.

Methods

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)

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
int	The number of routees associated with this pool.

Overrides

Pool.GetNrOfInstances(ActorSystem)

ToSurrogate(ActorSystem)

Creates a surrogate representation of the current SmallestMailboxPool.

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

Overrides

RouterConfig.ToSurrogate(ActorSystem)

WithDispatcher(string)

Creates a new SmallestMailboxPool router with a given dispatcher id.

note

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

Declaration

public SmallestMailboxPool WithDispatcher(string dispatcher)

Parameters

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

Returns

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

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)

WithResizer(Resizer)

Creates a new SmallestMailboxPool router with a given Resizer.

note

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

Declaration

public SmallestMailboxPool WithResizer(Resizer resizer)

Parameters

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

Returns

Type	Description
SmallestMailboxPool	A new router with the provided resizer.

WithSupervisorStrategy(SupervisorStrategy)

Creates a new SmallestMailboxPool router with a given SupervisorStrategy.

note

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

Declaration

public SmallestMailboxPool WithSupervisorStrategy(SupervisorStrategy strategy)

Parameters

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

Returns

Type	Description
SmallestMailboxPool	A new router with the provided strategy.

Implements

ISurrogated

IEquatable<T>

IEquatable<T>

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)