Package akka.routing

Class 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, java.io.Serializable
    A router pool that uses consistent hashing to select a routee based on the sent message. The selection is described in 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(akka.actor.SupervisorStrategy). If no strategy is provided, routers default to a strategy of &ldquo;always escalate&rdquo;. 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 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 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$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 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

      • 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

      • 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

      • 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

      • 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

      • nrOfInstances

        public int nrOfInstances​(ActorSystem sys)
        Description copied from interface: Pool
        Initial number of routee instances
        Specified by:
        nrOfInstances in interface Pool

      • 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.

      • 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 the hashMapping defined in code, since that can't be defined in configuration.
        Specified by:
        withFallback in interface RouterConfig

      • 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$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 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

      • productElementName

        public java.lang.String productElementName​(int x$1)
        Specified by:
        productElementName in interface scala.Product

      • 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