Class AdaptiveLoadBalancingPool

  • All Implemented Interfaces:
    Pool, RouterConfig, java.io.Serializable, scala.Equals, scala.Product, scala.Serializable

    public final class AdaptiveLoadBalancingPool
    extends java.lang.Object
    implements Pool, scala.Product, scala.Serializable
    A router pool that performs load balancing of messages to cluster nodes based on cluster metric data.

    It uses random selection of routees based on probabilities derived from the remaining capacity of corresponding node.

    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 “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: metricsSelector decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics

    param: nrOfInstances initial number of routees in the pool

    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

      • AdaptiveLoadBalancingPool

        public AdaptiveLoadBalancingPool​(MetricsSelector metricsSelector,
                                         int nrOfInstances,
                                         SupervisorStrategy supervisorStrategy,
                                         java.lang.String routerDispatcher,
                                         boolean usePoolDispatcher)
      • AdaptiveLoadBalancingPool

        public AdaptiveLoadBalancingPool​(com.typesafe.config.Config config,
                                         DynamicAccess dynamicAccess)
      • AdaptiveLoadBalancingPool

        public AdaptiveLoadBalancingPool​(MetricsSelector metricsSelector,
                                         int nr)
        Java API
        Parameters:
        metricsSelector - decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
        nr - initial number of routees in the pool
    • Method Detail

      • $lessinit$greater$default$1

        public static MetricsSelector $lessinit$greater$default$1()
      • $lessinit$greater$default$2

        public static int $lessinit$greater$default$2()
      • $lessinit$greater$default$3

        public static SupervisorStrategy $lessinit$greater$default$3()
      • $lessinit$greater$default$4

        public static java.lang.String $lessinit$greater$default$4()
      • $lessinit$greater$default$5

        public static boolean $lessinit$greater$default$5()
      • apply$default$2

        public static int apply$default$2()
      • apply$default$4

        public static java.lang.String apply$default$4()
      • apply$default$5

        public static boolean apply$default$5()
      • isManagementMessage

        public static boolean isManagementMessage​(java.lang.Object msg)
      • verifyConfig

        public static void verifyConfig​(ActorPath path)
      • enrichWithPoolDispatcher

        public static Props enrichWithPoolDispatcher​(Props routeeProps,
                                                     ActorContext context)
      • props

        public static Props props​(Props routeeProps)
      • stopRouterWhenAllRouteesRemoved

        public static boolean stopRouterWhenAllRouteesRemoved()
      • createRouterActor

        public static RouterActor createRouterActor()
      • nrOfInstances

        public int nrOfInstances()
      • 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
        Returns:
        (undocumented)
      • 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 interface RouterConfig
        Returns:
        (undocumented)
      • 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
        Returns:
        (undocumented)
      • 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
        Returns:
        (undocumented)
      • nrOfInstances

        public int nrOfInstances​(ActorSystem sys)
        Description copied from interface: Pool
        Initial number of routee instances
        Specified by:
        nrOfInstances in interface Pool
        Parameters:
        sys - (undocumented)
        Returns:
        (undocumented)
      • 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
        Returns:
        (undocumented)
      • routingLogicController

        public scala.Option<Props> routingLogicController​(RoutingLogic routingLogic)
        Description copied from interface: RouterConfig
        Possibility to define an actor for controlling the routing logic from external stimuli (e.g. monitoring metrics). This actor will be a child of the router "head" actor. Management messages not handled by the "head" actor are delegated to this controller actor.
        Specified by:
        routingLogicController in interface RouterConfig
        Parameters:
        routingLogic - (undocumented)
        Returns:
        (undocumented)
      • withSupervisorStrategy

        public AdaptiveLoadBalancingPool withSupervisorStrategy​(SupervisorStrategy strategy)
        Setting the supervisor strategy to be used for the &ldquo;head&rdquo; Router actor.
        Parameters:
        strategy - (undocumented)
        Returns:
        (undocumented)
      • withDispatcher

        public AdaptiveLoadBalancingPool 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.
        Parameters:
        dispatcherId - (undocumented)
        Returns:
        (undocumented)
      • withFallback

        public RouterConfig withFallback​(RouterConfig other)
        Uses the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one
        Specified by:
        withFallback in interface RouterConfig
        Parameters:
        other - (undocumented)
        Returns:
        (undocumented)
      • copy$default$2

        public int copy$default$2()
      • copy$default$4

        public java.lang.String copy$default$4()
      • copy$default$5

        public boolean copy$default$5()
      • 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