Package akka.routing

Class BalancingPool

java.lang.Object

akka.routing.BalancingPool

All Implemented Interfaces:

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

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

Java API param: nr initial number of routees in the pool

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BalancingPool(int nr)	Java API
BalancingPool(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
BalancingPool(com.typesafe.config.Config config)

Method Summary

Modifier and Type	Method	Description
static SupervisorStrategy	$lessinit$greater$default$2()
static java.lang.String	$lessinit$greater$default$3()
static BalancingPool	apply(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
static SupervisorStrategy	apply$default$2()
static java.lang.String	apply$default$3()
boolean	canEqual(java.lang.Object x$1)
BalancingPool	copy(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
int	copy$default$1()
SupervisorStrategy	copy$default$2()
java.lang.String	copy$default$3()
Router	createRouter(ActorSystem system)	Create the actual router, responsible for routing messages to routees.
boolean	equals(java.lang.Object x$1)
int	hashCode()
Routee	newRoutee(Props routeeProps, ActorContext context)	INTERNAL API
int	nrOfInstances()
int	nrOfInstances(ActorSystem sys)	Initial number of routee instances
int	productArity()
java.lang.Object	productElement(int x$1)
scala.collection.Iterator<java.lang.Object>	productIterator()
java.lang.String	productPrefix()
scala.Option<Resizer>	resizer()	Resizer cannot be used together with BalancingPool
java.lang.String	routerDispatcher()	Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
SupervisorStrategy	supervisorStrategy()	SupervisorStrategy for the head actor, i.e.
java.lang.String	toString()
static scala.Option<scala.Tuple3<java.lang.Object,SupervisorStrategy,java.lang.String>>	unapply(BalancingPool x$0)
BalancingPool	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.
RouterConfig	withFallback(RouterConfig other)	Uses the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one.
BalancingPool	withSupervisorStrategy(SupervisorStrategy strategy)	Setting the supervisor strategy to be used for the &ldquo;head&rdquo; Router actor.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface akka.routing.Pool

createRouterActor, enrichWithPoolDispatcher, props, stopRouterWhenAllRouteesRemoved, usePoolDispatcher

Methods inherited from interface akka.routing.RouterConfig

isManagementMessage, routingLogicController, verifyConfig

Constructor Detail

BalancingPool

public BalancingPool(int nrOfInstances,
                     SupervisorStrategy supervisorStrategy,
                     java.lang.String routerDispatcher)

BalancingPool

public BalancingPool(com.typesafe.config.Config config)

BalancingPool

public BalancingPool(int nr)

Java API

Parameters:

nr - initial number of routees in the pool

Method Detail

$lessinit$greater$default$2

public static SupervisorStrategy $lessinit$greater$default$2()

$lessinit$greater$default$3

public static java.lang.String $lessinit$greater$default$3()

apply

public static BalancingPool apply(int nrOfInstances,
                                  SupervisorStrategy supervisorStrategy,
                                  java.lang.String routerDispatcher)

apply$default$2

public static SupervisorStrategy apply$default$2()

apply$default$3

public static java.lang.String apply$default$3()

unapply

public static scala.Option<scala.Tuple3<java.lang.Object,SupervisorStrategy,java.lang.String>> unapply(BalancingPool x$0)

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)

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)

withSupervisorStrategy

public BalancingPool withSupervisorStrategy(SupervisorStrategy strategy)

Setting the supervisor strategy to be used for the “head” Router actor.

Parameters:

strategy - (undocumented)

Returns:

(undocumented)

withDispatcher

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

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)

newRoutee

public Routee newRoutee(Props routeeProps,
                        ActorContext context)

INTERNAL API

Specified by:

newRoutee in interface Pool

Parameters:

routeeProps - (undocumented)

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

resizer

public scala.Option<Resizer> resizer()

Resizer cannot be used together with BalancingPool

Specified by:

resizer in interface Pool

Returns:

(undocumented)

copy

public BalancingPool copy(int nrOfInstances,
                          SupervisorStrategy supervisorStrategy,
                          java.lang.String routerDispatcher)

copy$default$1

public int copy$default$1()

copy$default$2

public SupervisorStrategy copy$default$2()

copy$default$3

public java.lang.String 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