Class ConsistentHashingRoutingLogic
- java.lang.Object
-
- org.apache.pekko.routing.ConsistentHashingRoutingLogic
-
- All Implemented Interfaces:
java.io.Serializable
,NoSerializationVerificationNeeded
,RoutingLogic
,scala.Equals
,scala.Product
public final class ConsistentHashingRoutingLogic extends java.lang.Object implements RoutingLogic, scala.Product, java.io.Serializable
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ConsistentHashingRoutingLogic(ActorSystem system)
Java APIConsistentHashingRoutingLogic(ActorSystem system, int virtualNodesFactor, scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static int
$lessinit$greater$default$2()
Uses consistent hashing to select a routee based on the sent message.static scala.PartialFunction<java.lang.Object,java.lang.Object>
$lessinit$greater$default$3()
static ConsistentHashingRoutingLogic
apply(ActorSystem system, int virtualNodesFactor, scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping)
Uses consistent hashing to select a routee based on the sent message.static int
apply$default$2()
static scala.PartialFunction<java.lang.Object,java.lang.Object>
apply$default$3()
boolean
canEqual(java.lang.Object x$1)
ConsistentHashingRoutingLogic
copy(ActorSystem system, int virtualNodesFactor, scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping)
ActorSystem
copy$default$1()
int
copy$default$2()
scala.PartialFunction<java.lang.Object,java.lang.Object>
copy$default$3()
static Address
defaultAddress(ActorSystem system)
boolean
equals(java.lang.Object x$1)
int
hashCode()
scala.PartialFunction<java.lang.Object,java.lang.Object>
hashMapping()
int
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()
Routee
select(java.lang.Object message, scala.collection.immutable.IndexedSeq<Routee> routees)
Pick the destination for a given message.ActorSystem
system()
java.lang.String
toString()
static scala.Option<scala.Tuple3<ActorSystem,java.lang.Object,scala.PartialFunction<java.lang.Object,java.lang.Object>>>
unapply(ConsistentHashingRoutingLogic x$0)
int
virtualNodesFactor()
int
vnodes()
ConsistentHashingRoutingLogic
withHashMapper(ConsistentHashingRouter.ConsistentHashMapper mapper)
Java API: Setting the mapping from message to the data to use for the consistent hash key.ConsistentHashingRoutingLogic
withVirtualNodesFactor(int vnodes)
Setting the number of virtual nodes per node, used inpekko.routing.ConsistentHash
-
-
-
Constructor Detail
-
ConsistentHashingRoutingLogic
public ConsistentHashingRoutingLogic(ActorSystem system, int virtualNodesFactor, scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping)
-
ConsistentHashingRoutingLogic
public ConsistentHashingRoutingLogic(ActorSystem system)
Java API- Parameters:
system
- the actor system hosting this router
-
-
Method Detail
-
$lessinit$greater$default$2
public static int $lessinit$greater$default$2()
Uses consistent hashing to select a routee based on the sent message.There is 3 ways to define what data to use for the consistent hash key.
1. You can define
hashMapping
/withHashMapper
of the router to map incoming messages to their consistent hash key. This makes the decision transparent for the sender.2. The messages may implement
pekko.routing.ConsistentHashingRouter.ConsistentHashable
. The key is part of the message and it's convenient to define it together with the message definition.3. The messages can be wrapped in a
pekko.routing.ConsistentHashingRouter.ConsistentHashableEnvelope
to define what data to use for the consistent hash key. The sender knows the key to use.These ways to define the consistent hash key can be use together and at the same time for one router. The
hashMapping
is tried first.- Parameters:
virtualNodesFactor
- number of virtual nodes per node, used inpekko.routing.ConsistentHash
hashMapping
- partial function from message to the data to use for the consistent hash keysystem
- the actor system hosting this router
-
$lessinit$greater$default$3
public static scala.PartialFunction<java.lang.Object,java.lang.Object> $lessinit$greater$default$3()
-
defaultAddress
public static Address defaultAddress(ActorSystem system)
-
apply
public static ConsistentHashingRoutingLogic apply(ActorSystem system, int virtualNodesFactor, scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping)
Uses consistent hashing to select a routee based on the sent message.There is 3 ways to define what data to use for the consistent hash key.
1. You can define
hashMapping
/withHashMapper
of the router to map incoming messages to their consistent hash key. This makes the decision transparent for the sender.2. The messages may implement
pekko.routing.ConsistentHashingRouter.ConsistentHashable
. The key is part of the message and it's convenient to define it together with the message definition.3. The messages can be wrapped in a
pekko.routing.ConsistentHashingRouter.ConsistentHashableEnvelope
to define what data to use for the consistent hash key. The sender knows the key to use.These ways to define the consistent hash key can be use together and at the same time for one router. The
hashMapping
is tried first.- Parameters:
virtualNodesFactor
- number of virtual nodes per node, used inpekko.routing.ConsistentHash
hashMapping
- partial function from message to the data to use for the consistent hash keysystem
- the actor system hosting this router
-
apply$default$2
public static int apply$default$2()
-
apply$default$3
public static scala.PartialFunction<java.lang.Object,java.lang.Object> apply$default$3()
-
unapply
public static scala.Option<scala.Tuple3<ActorSystem,java.lang.Object,scala.PartialFunction<java.lang.Object,java.lang.Object>>> unapply(ConsistentHashingRoutingLogic x$0)
-
system
public ActorSystem system()
-
virtualNodesFactor
public int virtualNodesFactor()
-
hashMapping
public scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping()
-
vnodes
public int vnodes()
-
withVirtualNodesFactor
public ConsistentHashingRoutingLogic withVirtualNodesFactor(int vnodes)
Setting the number of virtual nodes per node, used inpekko.routing.ConsistentHash
-
withHashMapper
public ConsistentHashingRoutingLogic withHashMapper(ConsistentHashingRouter.ConsistentHashMapper mapper)
Java API: Setting the mapping from message to the data to use for the consistent hash key.
-
select
public Routee select(java.lang.Object message, scala.collection.immutable.IndexedSeq<Routee> routees)
Description copied from interface:RoutingLogic
Pick the destination for a given message. Normally it picks one of the passedroutees
, but in the end it is up to the implementation to return whateverpekko.routing.Routee
to use for sending a specific message.When implemented from Java it can be good to know that
routees.apply(index)
can be used to get an element from theIndexedSeq
.- Specified by:
select
in interfaceRoutingLogic
-
copy
public ConsistentHashingRoutingLogic copy(ActorSystem system, int virtualNodesFactor, scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping)
-
copy$default$1
public ActorSystem copy$default$1()
-
copy$default$2
public int copy$default$2()
-
copy$default$3
public scala.PartialFunction<java.lang.Object,java.lang.Object> copy$default$3()
-
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
-
-