akka.routing

Class ConsistentHashingRoutingLogic

java.lang.Object

akka.routing.ConsistentHashingRoutingLogic

All Implemented Interfaces:

NoSerializationVerificationNeeded, RoutingLogic, java.io.Serializable, scala.Equals, scala.Product

public final class ConsistentHashingRoutingLogic
extends java.lang.Object
implements RoutingLogic, scala.Product, scala.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConsistentHashingRoutingLogic(ActorSystem system) Java API
ConsistentHashingRoutingLogic(ActorSystem system, int virtualNodesFactor, scala.PartialFunction<java.lang.Object,java.lang.Object> hashMapping)

Method Summary

Modifier and Type	Method and Description
abstract static boolean	canEqual(java.lang.Object that)
static Address	defaultAddress(ActorSystem system) Address to use for the selfAddress parameter
abstract static boolean	equals(java.lang.Object that)
scala.PartialFunction<java.lang.Object,java.lang.Object>	hashMapping()
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()
Routee	select(java.lang.Object message, scala.collection.immutable.IndexedSeq<Routee> routees) Pick the destination for a given message.
ActorSystem	system()
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 in ConsistentHash

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

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

defaultAddress

public static Address defaultAddress(ActorSystem system)

Address to use for the selfAddress parameter

Parameters:

system - (undocumented)

Returns:

(undocumented)

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()

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 in ConsistentHash

Parameters:

vnodes - (undocumented)

Returns:

(undocumented)

withHashMapper

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

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 passed routees, but in the end it is up to the implementation to return whatever 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 the IndexedSeq.

Specified by:

select in interface RoutingLogic

Parameters:

message - (undocumented)

routees - (undocumented)

Returns:

(undocumented)