akka.cluster.routing
Class ClusterRouterPool

java.lang.Object
  akka.cluster.routing.ClusterRouterPool

All Implemented Interfaces:

ClusterRouterConfigBase, Pool, RouterConfig, java.io.Serializable, scala.Equals, scala.Product

public final class ClusterRouterPool
extends java.lang.Object
implements Pool, ClusterRouterConfigBase, scala.Product, scala.Serializable

RouterConfig implementation for deployment on cluster nodes. Delegates other duties to the local RouterConfig, which makes it possible to mix this with the built-in routers such as RoundRobinRouter or custom routers.

See Also:

Serialized Form

Constructor Summary

ClusterRouterPool(Pool local, ClusterRouterPoolSettings settings)

Method Summary

RouterActor	createRouterActor() INTERNAL API
Pool	local()
Routee	newRoutee(Props routeeProps, ActorContext context) INTERNAL API
int	nrOfInstances() Initial number of routee instances
scala.Option<Resizer>	resizer() Pool with dynamically resizable number of routees return the Resizer to use.
ClusterRouterPoolSettings	settings()
SupervisorStrategy	supervisorStrategy() SupervisorStrategy for the head actor, i.e.
RouterConfig	withFallback(RouterConfig other) Overridable merge strategy, by default completely prefers this (i.e.

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.routing.Pool

enrichWithPoolDispatcher, props, stopRouterWhenAllRouteesRemoved, usePoolDispatcher

Methods inherited from interface akka.cluster.routing.ClusterRouterConfigBase

createRouter, isManagementMessage, routerDispatcher, routingLogicController, stopRouterWhenAllRouteesRemoved

Methods inherited from interface akka.routing.RouterConfig

verifyConfig

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

ClusterRouterPool

public ClusterRouterPool(Pool local,
                         ClusterRouterPoolSettings settings)

Method Detail

local

public Pool local()

Specified by:

local in interface ClusterRouterConfigBase

settings

public ClusterRouterPoolSettings settings()

Specified by:

settings in interface ClusterRouterConfigBase

newRoutee

public Routee newRoutee(Props routeeProps,
                        ActorContext context)

INTERNAL API

Specified by:

newRoutee in interface Pool

Parameters:

routeeProps - (undocumented)

context - (undocumented)

Returns:

(undocumented)

nrOfInstances

public int nrOfInstances()

Initial number of routee instances

Specified by:

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

createRouterActor

public RouterActor createRouterActor()

INTERNAL API

Specified by:

createRouterActor in interface Pool

Specified by:

createRouterActor in interface RouterConfig

Returns:

(undocumented)

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)

withFallback

public RouterConfig withFallback(RouterConfig other)

Description copied from interface: RouterConfig

Overridable merge strategy, by default completely prefers this (i.e. no merge).

Specified by:

withFallback in interface RouterConfig

Parameters:

other - (undocumented)

Returns:

(undocumented)