Click or drag to resize
Akka.NETPool Class
This class provides base functionality for all pool routers in the system. Pool routers are routers that create their own routees based on the provided configuration.
Inheritance Hierarchy

Namespace:  Akka.Routing
Assembly:  Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax
Copy
public abstract class Pool : RouterConfig, 
	IEquatable<Pool>

The Pool type exposes the following members.

Constructors
  NameDescription
Protected methodPool
Initializes a new instance of the Pool class.
Note Note
If a routerDispatcher is not provided, this constructor sets up the pool to use the default dispatcher DefaultDispatcherId.
Top
Properties
  NameDescription
Public propertyStatic memberDefaultSupervisorStrategy
TBD
Public propertyNrOfInstances
Retrieves the current number of routees in the pool.
Public propertyResizer
Retrieve the resizer to use when dynamically allocating routees to the pool.
Public propertyRouterDispatcher
Dispatcher ID to use for running the "head" actor, which handles supervision, death watch and router management messages.
(Inherited from RouterConfig.)
Public propertyStopRouterWhenAllRouteesRemoved
Specify that this router should stop itself when all routees have terminated (been removed).
(Overrides RouterConfigStopRouterWhenAllRouteesRemoved.)
Public propertySupervisorStrategy
Retrieve the strategy to use when supervising the pool.
Public propertyUsePoolDispatcher
Retrieve whether or not to use the pool dispatcher. The dispatcher is defined in the 'pool-dispatcher' configuration property in the deployment section of the router.
Top
Methods
  NameDescription
Public methodCreateRouter
Creates a router that is responsible for routing messages to routees within the provided system.
(Inherited from RouterConfig.)
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Overrides RouterConfigEquals(Object).)
Public methodEquals(Pool)
Indicates whether the current object is equal to another object of the same type.
Public methodEquals(RouterConfig)
Indicates whether the current object is equal to another object of the same type.
(Inherited from RouterConfig.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Overrides ObjectGetHashCode.)
Public methodGetNrOfInstances
Used by the RoutedActorCell to determine the initial number of routees.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsManagementMessage
Determines whether a provided message is handled by the router.
(Inherited from RouterConfig.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodProps
Adds the current router to the provided routeeProps.
Public methodRoutingLogicController
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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodToSurrogate
Creates a surrogate representation of the current router.
(Inherited from RouterConfig.)
Public methodVerifyConfig
Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.
(Inherited from RouterConfig.)
Public methodWithFallback
Configure the current router with an auxiliary router for routes that it does not know how to handle.
(Inherited from RouterConfig.)
Top
Extension Methods
See Also
Inheritance Hierarchy