akka.routing

Class ConsistentHashingPool

java.lang.Object

akka.routing.ConsistentHashingPool

All Implemented Interfaces:

Pool, PoolOverrideUnsetConfig<ConsistentHashingPool>, RouterConfig, java.io.Serializable, scala.Equals, scala.Product

public final class ConsistentHashingPool
extends java.lang.Object
implements Pool, PoolOverrideUnsetConfig<ConsistentHashingPool>, scala.Product, scala.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConsistentHashingPool(com.typesafe.config.Config config)
ConsistentHashingPool(int nr)
ConsistentHashingPool(int nrOfInstances, scala.Option<Resizer> resizer, int virtualNodesFactor, scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher, boolean usePoolDispatcher)

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()
int	nrOfInstances() Initial number of routee instances
scala.Option<Resizer>	resizer() Pool with dynamically resizable number of routees return the Resizer to use.
java.lang.String	routerDispatcher() Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
SupervisorStrategy	supervisorStrategy() SupervisorStrategy for the head actor, i.e.
boolean	usePoolDispatcher() Use a dedicated dispatcher for the routees of the pool.
int	virtualNodesFactor()
ConsistentHashingPool	withDispatcher(java.lang.String dispatcherId)
RouterConfig	withFallback(RouterConfig other) Overridable merge strategy, by default completely prefers this (i.e.
ConsistentHashingPool	withHashMapper(ConsistentHashingRouter.ConsistentHashMapper mapper)
ConsistentHashingPool	withResizer(Resizer resizer)
ConsistentHashingPool	withSupervisorStrategy(SupervisorStrategy strategy)
ConsistentHashingPool	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.PoolOverrideUnsetConfig

overrideUnsetConfig

Methods inherited from interface akka.routing.Pool

createRouterActor, enrichWithPoolDispatcher, newRoutee, props, stopRouterWhenAllRouteesRemoved

Methods inherited from interface akka.routing.RouterConfig

isManagementMessage, routingLogicController, verifyConfig

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

ConsistentHashingPool

public ConsistentHashingPool(int nrOfInstances,
                             scala.Option<Resizer> resizer,
                             int virtualNodesFactor,
                             scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping,
                             SupervisorStrategy supervisorStrategy,
                             java.lang.String routerDispatcher,
                             boolean usePoolDispatcher)

ConsistentHashingPool

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

ConsistentHashingPool

public ConsistentHashingPool(int nr)

Method Detail

nrOfInstances

public int nrOfInstances()

Description copied from interface: Pool

Initial number of routee instances

Specified by:

nrOfInstances in interface Pool

Returns:

(undocumented)

resizer

public scala.Option<Resizer> resizer()

Description copied from interface: Pool

Pool with dynamically resizable number of routees return the Resizer to use. The resizer is invoked once when the router is created, before any messages can be sent to it. Resize is also triggered when messages are sent to the routees, and the resizer is invoked asynchronously, i.e. not necessarily before the message has been sent.

Specified by:

resizer in interface Pool

Returns:

(undocumented)

virtualNodesFactor

public int virtualNodesFactor()

hashMapping

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

supervisorStrategy

public SupervisorStrategy supervisorStrategy()

Description copied from interface: Pool

SupervisorStrategy for the head actor, i.e. for supervising the routees of the pool.

Specified by:

supervisorStrategy in interface Pool

Returns:

(undocumented)

routerDispatcher

public java.lang.String routerDispatcher()

Description copied from interface: RouterConfig

Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages

Specified by:

routerDispatcher in interface RouterConfig

Returns:

(undocumented)

usePoolDispatcher

public boolean usePoolDispatcher()

Description copied from interface: Pool

Use a dedicated dispatcher for the routees of the pool. The dispatcher is defined in 'pool-dispatcher' configuration property in the deployment section of the router.

Specified by:

usePoolDispatcher in interface Pool

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)

withSupervisorStrategy

public ConsistentHashingPool withSupervisorStrategy(SupervisorStrategy strategy)

Specified by:

withSupervisorStrategy in interface PoolOverrideUnsetConfig<ConsistentHashingPool>

withResizer

public ConsistentHashingPool withResizer(Resizer resizer)

Specified by:

withResizer in interface PoolOverrideUnsetConfig<ConsistentHashingPool>

withDispatcher

public ConsistentHashingPool withDispatcher(java.lang.String dispatcherId)

withVirtualNodesFactor

public ConsistentHashingPool withVirtualNodesFactor(int vnodes)

withHashMapper

public ConsistentHashingPool 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)