Click or drag to resize
Akka.NETConsistentHashingPool Class
This class represents a Pool router that sends messages to a Routee determined using consistent-hashing. Please refer to ConsistentHashingRoutingLogic for more information on consistent hashing.
Note Note
Using Resizer with ConsistentHashingPool is potentially harmful, as hash ranges might change radically during live message processing. This router works best with fixed-sized pools or fixed number of routees per node in the event of clustered deployments.
Inheritance Hierarchy

Namespace:  Akka.Routing
Assembly:  Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax
Copy
public sealed class ConsistentHashingPool : Pool

The ConsistentHashingPool type exposes the following members.

Constructors
  NameDescription
Public methodConsistentHashingPool(Int32)
Initializes a new instance of the ConsistentHashingPool class.
Note Note
A ConsistentHashingPool configured in this way uses the DefaultSupervisorStrategy supervisor strategy.
Public methodConsistentHashingPool(Config)
Initializes a new instance of the ConsistentHashingPool class.
Note Note
'virtual-nodes-factor' defaults to 0 (zero) if it is not defined in the provided configuration.
Public methodConsistentHashingPool(Int32, ConsistentHashMapping)
Initializes a new instance of the ConsistentHashingPool class.
Public methodConsistentHashingPool(Int32, Resizer, SupervisorStrategy, String, Boolean, Int32, ConsistentHashMapping)
Initializes a new instance of the ConsistentHashingPool class.
Top
Properties
  NameDescription
Public propertyNrOfInstances
Retrieves the current number of routees in the pool.
(Inherited from Pool.)
Public propertyResizer
Retrieve the resizer to use when dynamically allocating routees to the pool.
(Inherited from 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).
(Inherited from Pool.)
Public propertySupervisorStrategy
Retrieve the strategy to use when supervising the pool.
(Inherited from 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.
(Inherited from Pool.)
Public propertyVirtualNodesFactor
Virtual nodes used in the ConsistentHashT.
Top
Methods
  NameDescription
Public methodCreateRouter
Creates a router that is responsible for routing messages to routees within the provided system.
(Overrides RouterConfigCreateRouter(ActorSystem).)
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Inherited from Pool.)
Public methodEquals(Pool)
Indicates whether the current object is equal to another object of the same type.
(Inherited from Pool.)
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.
(Inherited from Pool.)
Public methodGetNrOfInstances
Used by the RoutedActorCell to determine the initial number of routees.
(Overrides PoolGetNrOfInstances(ActorSystem).)
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.
(Inherited from Pool.)
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 ConsistentHashingPool.
(Overrides RouterConfigToSurrogate(ActorSystem).)
Public methodVerifyConfig
Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.
(Inherited from RouterConfig.)
Public methodWithDispatcher
Creates a new ConsistentHashingPool router with a given dispatcher id.
Note Note
This method is immutable and returns a new instance of the router.
Public methodWithFallback
Configure the current router with an auxiliary router for routes that it does not know how to handle.
(Overrides RouterConfigWithFallback(RouterConfig).)
Public methodWithHashMapping
Creates a new ConsistentHashingPool router with a given ConsistentHashMapping.
Note Note
This method is immutable and returns a new instance of the router.
Public methodWithResizer
Creates a new ConsistentHashingPool router with a given Resizer.
Note Note
This method is immutable and returns a new instance of the router.
Note Note
Using Resizer with ConsistentHashingPool is potentially harmful, as hash ranges might change radically during live message processing. This router works best with fixed-sized pools or fixed number of routees per node in the event of clustered deployments.
Public methodWithSupervisorStrategy
Creates a new ConsistentHashingPool router with a given SupervisorStrategy.
Note Note
This method is immutable and returns a new instance of the router.
Public methodWithVirtualNodesFactor
Setting the number of virtual nodes per node, used in ConsistentHash.
Top
Extension Methods
See Also