Package akka.routing

Class ConsistentHashingRoutingLogic

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

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

        system - the actor system hosting this router

        Returns:
        (undocumented)
      • $lessinit$greater$default$3

        public static scala.PartialFunction<java.lang.Object,​java.lang.Object> $lessinit$greater$default$3()
      • 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 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 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 in ConsistentHash

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

        system - the actor system hosting this router

        Returns:
        (undocumented)
      • 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()
      • 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)
      • 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)
      • 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 interface scala.Product
      • productArity

        public int productArity()
        Specified by:
        productArity in interface scala.Product
      • productElement

        public java.lang.Object productElement​(int x$1)
        Specified by:
        productElement in interface scala.Product
      • productIterator

        public scala.collection.Iterator<java.lang.Object> productIterator()
        Specified by:
        productIterator in interface scala.Product
      • canEqual

        public boolean canEqual​(java.lang.Object x$1)
        Specified by:
        canEqual in interface scala.Equals
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object x$1)
        Specified by:
        equals in interface scala.Equals
        Overrides:
        equals in class java.lang.Object