Class ConsistentHashingPool
- java.lang.Object
-
- org.apache.pekko.routing.ConsistentHashingPool
-
- All Implemented Interfaces:
java.io.Serializable
,Pool
,PoolOverrideUnsetConfig<ConsistentHashingPool>
,RouterConfig
,scala.Equals
,scala.Product
public final class ConsistentHashingPool extends java.lang.Object implements Pool, PoolOverrideUnsetConfig<ConsistentHashingPool>, scala.Product, java.io.Serializable
A router pool that uses consistent hashing to select a routee based on the sent message. The selection is described inpekko.routing.ConsistentHashingRoutingLogic
.The configuration parameter trumps the constructor arguments. This means that if you provide
nrOfInstances
during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.Supervision Setup
Any routees that are created by a router will be created as the router's children. The router is therefore also the children's supervisor.
The supervision strategy of the router actor can be configured with
withSupervisorStrategy(org.apache.pekko.actor.SupervisorStrategy)
. If no strategy is provided, routers default to a strategy of “always escalate”. This means that errors are passed up to the router's supervisor for handling.The router's supervisor will treat the error as an error with the router itself. Therefore a directive to stop or restart will cause the router itself to stop or restart. The router, in turn, will cause its children to stop and restart.
param: nrOfInstances initial number of routees in the pool
param: resizer optional resizer that dynamically adjust the pool size
param: virtualNodesFactor number of virtual nodes per node, used in
pekko.routing.ConsistentHash
param: hashMapping partial function from message to the data to use for the consistent hash key
param: supervisorStrategy strategy for supervising the routees, see 'Supervision Setup'
param: routerDispatcher dispatcher to use for the router head actor, which handles supervision, death watch and router management messages
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ConsistentHashingPool(int nr)
Java APIConsistentHashingPool(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(com.typesafe.config.Config config)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static scala.Option<Resizer>
$lessinit$greater$default$2()
static int
$lessinit$greater$default$3()
static scala.PartialFunction<java.lang.Object,java.lang.Object>
$lessinit$greater$default$4()
static SupervisorStrategy
$lessinit$greater$default$5()
static java.lang.String
$lessinit$greater$default$6()
static boolean
$lessinit$greater$default$7()
static ConsistentHashingPool
apply(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)
static scala.Option<Resizer>
apply$default$2()
static int
apply$default$3()
static scala.PartialFunction<java.lang.Object,java.lang.Object>
apply$default$4()
static SupervisorStrategy
apply$default$5()
static java.lang.String
apply$default$6()
static boolean
apply$default$7()
boolean
canEqual(java.lang.Object x$1)
ConsistentHashingPool
copy(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)
int
copy$default$1()
scala.Option<Resizer>
copy$default$2()
int
copy$default$3()
scala.PartialFunction<java.lang.Object,java.lang.Object>
copy$default$4()
SupervisorStrategy
copy$default$5()
java.lang.String
copy$default$6()
boolean
copy$default$7()
Router
createRouter(ActorSystem system)
Create the actual router, responsible for routing messages to routees.boolean
equals(java.lang.Object x$1)
int
hashCode()
scala.PartialFunction<java.lang.Object,java.lang.Object>
hashMapping()
int
nrOfInstances()
int
nrOfInstances(ActorSystem sys)
Initial number of routee instancesint
productArity()
java.lang.Object
productElement(int x$1)
java.lang.String
productElementName(int x$1)
scala.collection.Iterator<java.lang.Object>
productIterator()
java.lang.String
productPrefix()
scala.Option<Resizer>
resizer()
Pool with dynamically resizable number of routees return thepekko.routing.Resizer
to use.java.lang.String
routerDispatcher()
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messagesSupervisorStrategy
supervisorStrategy()
SupervisorStrategy for the head actor, i.e.java.lang.String
toString()
static scala.Option<scala.Tuple7<java.lang.Object,scala.Option<Resizer>,java.lang.Object,scala.PartialFunction<java.lang.Object,java.lang.Object>,SupervisorStrategy,java.lang.String,java.lang.Object>>
unapply(ConsistentHashingPool x$0)
boolean
usePoolDispatcher()
Use a dedicated dispatcher for the routees of the pool.int
virtualNodesFactor()
ConsistentHashingPool
withDispatcher(java.lang.String dispatcherId)
Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.RouterConfig
withFallback(RouterConfig other)
Uses the resizer and/or the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one, i.e.ConsistentHashingPool
withHashMapper(ConsistentHashingRouter.ConsistentHashMapper mapper)
Java API: Setting the mapping from message to the data to use for the consistent hash key.ConsistentHashingPool
withResizer(Resizer resizer)
Setting the resizer to be used.ConsistentHashingPool
withSupervisorStrategy(SupervisorStrategy strategy)
Setting the supervisor strategy to be used for the “head” Router actor.ConsistentHashingPool
withVirtualNodesFactor(int vnodes)
Setting the number of virtual nodes per node, used inpekko.routing.ConsistentHash
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.pekko.routing.Pool
createRouterActor, enrichWithPoolDispatcher, newRoutee, props, stopRouterWhenAllRouteesRemoved
-
Methods inherited from interface org.apache.pekko.routing.PoolOverrideUnsetConfig
overrideUnsetConfig
-
Methods inherited from interface org.apache.pekko.routing.RouterConfig
isManagementMessage, routingLogicController, verifyConfig
-
-
-
-
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)
Java API- Parameters:
nr
- initial number of routees in the pool
-
-
Method Detail
-
$lessinit$greater$default$2
public static scala.Option<Resizer> $lessinit$greater$default$2()
-
$lessinit$greater$default$3
public static int $lessinit$greater$default$3()
-
$lessinit$greater$default$4
public static scala.PartialFunction<java.lang.Object,java.lang.Object> $lessinit$greater$default$4()
-
$lessinit$greater$default$5
public static SupervisorStrategy $lessinit$greater$default$5()
-
$lessinit$greater$default$6
public static java.lang.String $lessinit$greater$default$6()
-
$lessinit$greater$default$7
public static boolean $lessinit$greater$default$7()
-
apply
public static ConsistentHashingPool apply(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)
-
apply$default$2
public static scala.Option<Resizer> apply$default$2()
-
apply$default$3
public static int apply$default$3()
-
apply$default$4
public static scala.PartialFunction<java.lang.Object,java.lang.Object> apply$default$4()
-
apply$default$5
public static SupervisorStrategy apply$default$5()
-
apply$default$6
public static java.lang.String apply$default$6()
-
apply$default$7
public static boolean apply$default$7()
-
unapply
public static scala.Option<scala.Tuple7<java.lang.Object,scala.Option<Resizer>,java.lang.Object,scala.PartialFunction<java.lang.Object,java.lang.Object>,SupervisorStrategy,java.lang.String,java.lang.Object>> unapply(ConsistentHashingPool x$0)
-
nrOfInstances
public int nrOfInstances()
-
resizer
public scala.Option<Resizer> resizer()
Description copied from interface:Pool
Pool with dynamically resizable number of routees return thepekko.routing.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.
-
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 interfacePool
-
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 interfaceRouterConfig
-
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 interfacePool
-
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 interfaceRouterConfig
- Parameters:
system
- the ActorSystem this router belongs to
-
nrOfInstances
public int nrOfInstances(ActorSystem sys)
Description copied from interface:Pool
Initial number of routee instances- Specified by:
nrOfInstances
in interfacePool
-
withSupervisorStrategy
public ConsistentHashingPool withSupervisorStrategy(SupervisorStrategy strategy)
Setting the supervisor strategy to be used for the “head” Router actor.- Specified by:
withSupervisorStrategy
in interfacePoolOverrideUnsetConfig<ConsistentHashingPool>
-
withResizer
public ConsistentHashingPool withResizer(Resizer resizer)
Setting the resizer to be used.- Specified by:
withResizer
in interfacePoolOverrideUnsetConfig<ConsistentHashingPool>
-
withDispatcher
public ConsistentHashingPool withDispatcher(java.lang.String dispatcherId)
Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.
-
withVirtualNodesFactor
public ConsistentHashingPool withVirtualNodesFactor(int vnodes)
Setting the number of virtual nodes per node, used inpekko.routing.ConsistentHash
-
withHashMapper
public ConsistentHashingPool withHashMapper(ConsistentHashingRouter.ConsistentHashMapper mapper)
Java API: Setting the mapping from message to the data to use for the consistent hash key.
-
withFallback
public RouterConfig withFallback(RouterConfig other)
Uses the resizer and/or the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one, i.e. the resizer defined in code is used if resizer was not defined in config. Uses thehashMapping
defined in code, since that can't be defined in configuration.- Specified by:
withFallback
in interfaceRouterConfig
-
copy
public ConsistentHashingPool copy(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)
-
copy$default$1
public int copy$default$1()
-
copy$default$2
public scala.Option<Resizer> copy$default$2()
-
copy$default$3
public int copy$default$3()
-
copy$default$4
public scala.PartialFunction<java.lang.Object,java.lang.Object> copy$default$4()
-
copy$default$5
public SupervisorStrategy copy$default$5()
-
copy$default$6
public java.lang.String copy$default$6()
-
copy$default$7
public boolean copy$default$7()
-
productPrefix
public java.lang.String productPrefix()
- Specified by:
productPrefix
in interfacescala.Product
-
productArity
public int productArity()
- Specified by:
productArity
in interfacescala.Product
-
productElement
public java.lang.Object productElement(int x$1)
- Specified by:
productElement
in interfacescala.Product
-
productIterator
public scala.collection.Iterator<java.lang.Object> productIterator()
- Specified by:
productIterator
in interfacescala.Product
-
canEqual
public boolean canEqual(java.lang.Object x$1)
- Specified by:
canEqual
in interfacescala.Equals
-
productElementName
public java.lang.String productElementName(int x$1)
- Specified by:
productElementName
in interfacescala.Product
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object x$1)
- Specified by:
equals
in interfacescala.Equals
- Overrides:
equals
in classjava.lang.Object
-
-