akka.routing

Class ConsistentHashingGroup

java.lang.Object

akka.routing.ConsistentHashingGroup

All Implemented Interfaces:

Group, RouterConfig, java.io.Serializable, scala.Equals, scala.Product

public final class ConsistentHashingGroup
extends java.lang.Object
implements Group, scala.Product, scala.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConsistentHashingGroup(com.typesafe.config.Config config)
ConsistentHashingGroup(java.lang.Iterable<java.lang.String> routeePaths)
ConsistentHashingGroup(scala.collection.immutable.Iterable<java.lang.String> paths, int virtualNodesFactor, scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping, java.lang.String routerDispatcher)

Method Summary

Modifier and Type	Method and Description
Router	createRouter(ActorSystem system) Create the actual router, responsible for routing messages to routees.
scala.PartialFunction<java.lang.Object,java.lang.Object>	hashMapping()
scala.collection.immutable.Iterable<java.lang.String>	paths()
java.lang.String	routerDispatcher() Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
int	virtualNodesFactor()
ConsistentHashingGroup	withDispatcher(java.lang.String dispatcherId)
RouterConfig	withFallback(RouterConfig other) Overridable merge strategy, by default completely prefers this (i.e.
ConsistentHashingGroup	withHashMapper(ConsistentHashingRouter.ConsistentHashMapper mapper)
ConsistentHashingGroup	withVirtualNodesFactor(int vnodes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akka.routing.Group

createRouterActor, props, routeeFor

Methods inherited from interface akka.routing.RouterConfig

isManagementMessage, routingLogicController, stopRouterWhenAllRouteesRemoved, verifyConfig

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

ConsistentHashingGroup

public ConsistentHashingGroup(scala.collection.immutable.Iterable<java.lang.String> paths,
                              int virtualNodesFactor,
                              scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping,
                              java.lang.String routerDispatcher)

ConsistentHashingGroup

public ConsistentHashingGroup(com.typesafe.config.Config config)

ConsistentHashingGroup

public ConsistentHashingGroup(java.lang.Iterable<java.lang.String> routeePaths)

Method Detail

paths

public scala.collection.immutable.Iterable<java.lang.String> paths()

Specified by:

paths in interface Group

virtualNodesFactor

public int virtualNodesFactor()

hashMapping

public scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping()

routerDispatcher

public java.lang.String routerDispatcher()

Description copied from interface: RouterConfig

Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

Specified by:

routerDispatcher in interface RouterConfig

Returns:

(undocumented)

createRouter

public Router createRouter(ActorSystem system)

Description copied from interface: RouterConfig

Create the actual router, responsible for routing messages to routees.

Specified by:

createRouter in interface RouterConfig

Parameters:

system - the ActorSystem this router belongs to

Returns:

(undocumented)

withDispatcher

public ConsistentHashingGroup withDispatcher(java.lang.String dispatcherId)

withVirtualNodesFactor

public ConsistentHashingGroup withVirtualNodesFactor(int vnodes)

withHashMapper

public ConsistentHashingGroup withHashMapper(ConsistentHashingRouter.ConsistentHashMapper mapper)

withFallback

public RouterConfig withFallback(RouterConfig other)

Description copied from interface: RouterConfig

Overridable merge strategy, by default completely prefers this (i.e. no merge).

Specified by:

withFallback in interface RouterConfig

Parameters:

other - (undocumented)

Returns:

(undocumented)