C# Class Akka.Routing.ConsistentHashingGroup

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: Akka.Routing.Group
ファイルを表示 Open project: rogeralsing/akka.net

Protected Properties

Property Type Description
HashMapping ConsistentHashMapping

Public Methods

Method Description
ConsistentHashingGroup ( ) : System

Initializes a new instance of the ConsistentHashingGroup class.

ConsistentHashingGroup ( Config config ) : System

Initializes a new instance of the ConsistentHashingGroup class.

ConsistentHashingGroup ( IEnumerable routees, int virtualNodesFactor, ConsistentHashMapping hashMapping = null ) : System

Initializes a new instance of the ConsistentHashingGroup class.

ConsistentHashingGroup ( IEnumerable paths, int virtualNodesFactor, ConsistentHashMapping hashMapping = null ) : System

Initializes a new instance of the ConsistentHashingGroup class.

CreateRouter ( ActorSystem system ) : Router

Creates a router that is responsible for routing messages to routees within the provided system.

ToSurrogate ( ActorSystem system ) : ISurrogate

Creates a surrogate representation of the current ConsistentHashingGroup.

WithDispatcher ( string dispatcher ) : Akka.Routing.Group

Creates a new ConsistentHashingGroup router with a given dispatcher id. This method is immutable and returns a new instance of the router.

WithFallback ( Akka.Routing.RouterConfig routerConfig ) : Akka.Routing.RouterConfig

Configure the current router with an auxiliary router for routes that it does not know how to handle.

WithHashMapping ( ConsistentHashMapping mapping ) : ConsistentHashingGroup

Creates a new ConsistentHashingGroup router with a given ConsistentHashMapping. This method is immutable and returns a new instance of the router.

WithVirtualNodesFactor ( int vnodes ) : ConsistentHashingGroup

Creates a new ConsistentHashingGroup router with a given VirtualNodesFactor. This method is immutable and returns a new instance of the router.

Method Details

ConsistentHashingGroup() public method

Initializes a new instance of the ConsistentHashingGroup class.
public ConsistentHashingGroup ( ) : System
return System

ConsistentHashingGroup() public method

Initializes a new instance of the ConsistentHashingGroup class.
public ConsistentHashingGroup ( Config config ) : System
config Akka.Configuration.Config /// The configuration to use to lookup paths used by the group router. /// /// /// If 'routees.path' is defined in the provided configuration then those paths will be used by the router. /// 'virtual-nodes-factor' defaults to 0 (zero) if it is not defined in the provided configuration. /// ///
return System

ConsistentHashingGroup() public method

Initializes a new instance of the ConsistentHashingGroup class.
public ConsistentHashingGroup ( IEnumerable routees, int virtualNodesFactor, ConsistentHashMapping hashMapping = null ) : System
routees IEnumerable An enumeration of routees used by the group router.
virtualNodesFactor int The number of virtual nodes to use on the hash ring.
hashMapping ConsistentHashMapping The consistent hash mapping function to use on incoming messages.
return System

ConsistentHashingGroup() public method

Initializes a new instance of the ConsistentHashingGroup class.
public ConsistentHashingGroup ( IEnumerable paths, int virtualNodesFactor, ConsistentHashMapping hashMapping = null ) : System
paths IEnumerable An enumeration of actor paths used by the group router.
virtualNodesFactor int The number of virtual nodes to use on the hash ring.
hashMapping ConsistentHashMapping The consistent hash mapping function to use on incoming messages.
return System

CreateRouter() public method

Creates a router that is responsible for routing messages to routees within the provided system.
public CreateRouter ( ActorSystem system ) : Router
system ActorSystem The actor system that owns this router.
return Router

ToSurrogate() public method

Creates a surrogate representation of the current ConsistentHashingGroup.
public ToSurrogate ( ActorSystem system ) : ISurrogate
system ActorSystem The actor system that owns this router.
return ISurrogate

WithDispatcher() public method

Creates a new ConsistentHashingGroup router with a given dispatcher id. This method is immutable and returns a new instance of the router.
public WithDispatcher ( string dispatcher ) : Akka.Routing.Group
dispatcher string The dispatcher id used to configure the new router.
return Akka.Routing.Group

WithFallback() public method

Configure the current router with an auxiliary router for routes that it does not know how to handle.
Expected ConsistentHashingGroup, got .
public WithFallback ( Akka.Routing.RouterConfig routerConfig ) : Akka.Routing.RouterConfig
routerConfig Akka.Routing.RouterConfig The router to use as an auxiliary source.
return Akka.Routing.RouterConfig

WithHashMapping() public method

Creates a new ConsistentHashingGroup router with a given ConsistentHashMapping. This method is immutable and returns a new instance of the router.
public WithHashMapping ( ConsistentHashMapping mapping ) : ConsistentHashingGroup
mapping ConsistentHashMapping The used to configure the new router.
return ConsistentHashingGroup

WithVirtualNodesFactor() public method

Creates a new ConsistentHashingGroup router with a given VirtualNodesFactor. This method is immutable and returns a new instance of the router.
public WithVirtualNodesFactor ( int vnodes ) : ConsistentHashingGroup
vnodes int The used to configure the new router.
return ConsistentHashingGroup

Property Details

HashMapping protected_oe property

The consistent hash mapping function to use on incoming messages.
protected ConsistentHashMapping HashMapping
return ConsistentHashMapping