Click or drag to resize
Akka.NETConsistentHashingGroup Class
This class represents a Group router that sends messages to a Routee determined using consistent-hashing. Please refer to ConsistentHashingRoutingLogic for more information on consistent hashing.
Inheritance Hierarchy

Namespace:  Akka.Routing
Assembly:  Akka (in Akka.dll) Version: 1.2.3.129 (1.2.3.129)
Syntax
public sealed class ConsistentHashingGroup : Group

The ConsistentHashingGroup type exposes the following members.

Constructors
  NameDescription
Public methodConsistentHashingGroup(IEnumerableString)
Initializes a new instance of the ConsistentHashingGroup class.
Public methodConsistentHashingGroup(String)
Initializes a new instance of the ConsistentHashingGroup class.
Public methodConsistentHashingGroup(Config)
Initializes a new instance of the ConsistentHashingGroup class.
Public methodConsistentHashingGroup(IEnumerableIActorRef) Obsolete.
Public methodConsistentHashingGroup(IEnumerableString, ConsistentHashMapping)
Initializes a new instance of the ConsistentHashingGroup class.
Public methodConsistentHashingGroup(IEnumerableString, Int32, ConsistentHashMapping, String)
Initializes a new instance of the ConsistentHashingGroup class.
Top
Properties
  NameDescription
Public propertyPaths
TBD
(Inherited from Group.)
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). By Default it is `true`, unless a `resizer` is used.
(Inherited from RouterConfig.)
Public propertyVirtualNodesFactor
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 Group.)
Public methodEquals(Group)
Indicates whether the current object is equal to another object of the same type.
(Inherited from Group.)
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 Group.)
Public methodGetPaths
Retrieves the actor paths used by this router during routee selection.
(Overrides GroupGetPaths(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 an empty Props.
(Inherited from Group.)
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 ConsistentHashingGroup.
(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 ConsistentHashingGroup 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 ConsistentHashingGroup router with a given ConsistentHashMapping.
Note Note
This method is immutable and returns a new instance of the router.
Public methodWithVirtualNodesFactor
Creates a new ConsistentHashingGroup router with a given VirtualNodesFactor.
Note Note
This method is immutable and returns a new instance of the router.
Top
Extension Methods
See Also