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

A router group that uses consistent hashing to select a routee based on the sent message. The selection is described in ConsistentHashingRoutingLogic.

The configuration parameter trumps the constructor arguments. This means that if you provide paths during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.

param: paths string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths

param: virtualNodesFactor number of virtual nodes per node, used in ConsistentHash

param: hashMapping partial function from message to the data to use for the consistent hash key

param: routerDispatcher dispatcher to use for the router head actor, which handles router management messages

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConsistentHashingGroup(com.typesafe.config.Config config)
ConsistentHashingGroup(java.lang.Iterable<java.lang.String> routeePaths) Java API
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
abstract static boolean	canEqual(java.lang.Object that)
Router	createRouter(ActorSystem system) Create the actual router, responsible for routing messages to routees.
static RouterActor	createRouterActor()
abstract static boolean	equals(java.lang.Object that)
scala.PartialFunction<java.lang.Object,java.lang.Object>	hashMapping()
static boolean	isManagementMessage(java.lang.Object msg)
scala.collection.immutable.Iterable<java.lang.String>	paths()
scala.collection.immutable.Iterable<java.lang.String>	paths(ActorSystem system)
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
static Props	props()
static Routee	routeeFor(java.lang.String path, ActorContext context)
java.lang.String	routerDispatcher() Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
static scala.Option<Props>	routingLogicController(RoutingLogic routingLogic)
static boolean	stopRouterWhenAllRouteesRemoved()
static void	verifyConfig(ActorPath path)
int	virtualNodesFactor()
ConsistentHashingGroup	withDispatcher(java.lang.String dispatcherId) Setting the dispatcher to be used for the router head actor, which handles router management messages
RouterConfig	withFallback(RouterConfig other) Uses the hashMapping defined in code, since that can't be defined in configuration.
ConsistentHashingGroup	withHashMapper(ConsistentHashingRouter.ConsistentHashMapper mapper) Java API: Setting the mapping from message to the data to use for the consistent hash key.
ConsistentHashingGroup	withVirtualNodesFactor(int vnodes) Setting the number of virtual nodes per node, used in ConsistentHash

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

$init$, 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)

Java API

Parameters:

routeePaths - string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths

Method Detail

routingLogicController

public static scala.Option<Props> routingLogicController(RoutingLogic routingLogic)

isManagementMessage

public static boolean isManagementMessage(java.lang.Object msg)

stopRouterWhenAllRouteesRemoved

public static boolean stopRouterWhenAllRouteesRemoved()

verifyConfig

public static void verifyConfig(ActorPath path)

props

public static Props props()

routeeFor

public static Routee routeeFor(java.lang.String path,
                               ActorContext context)

createRouterActor

public static RouterActor createRouterActor()

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

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)

paths

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

Specified by:

paths in interface Group

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)

Setting the dispatcher to be used for the router head actor, which handles router management messages

Parameters:

dispatcherId - (undocumented)

Returns:

(undocumented)

withVirtualNodesFactor

public ConsistentHashingGroup withVirtualNodesFactor(int vnodes)

Setting the number of virtual nodes per node, used in ConsistentHash

Parameters:

vnodes - (undocumented)

Returns:

(undocumented)

withHashMapper

public ConsistentHashingGroup withHashMapper(ConsistentHashingRouter.ConsistentHashMapper mapper)

Java API: Setting the mapping from message to the data to use for the consistent hash key.

Parameters:

mapper - (undocumented)

Returns:

(undocumented)

withFallback

public RouterConfig withFallback(RouterConfig other)

Uses the hashMapping defined in code, since that can't be defined in configuration.

Specified by:

withFallback in interface RouterConfig

Parameters:

other - (undocumented)

Returns:

(undocumented)