Package akka.routing
Class TailChoppingPool
- java.lang.Object
-
- akka.routing.TailChoppingPool
-
- All Implemented Interfaces:
Pool
,PoolOverrideUnsetConfig<TailChoppingPool>
,RouterConfig
,java.io.Serializable
,scala.Equals
,scala.Product
,scala.Serializable
public final class TailChoppingPool extends java.lang.Object implements Pool, PoolOverrideUnsetConfig<TailChoppingPool>, scala.Product, scala.Serializable
Java API param: nr initial number of routees in the pool param: within expecting at least one reply within this duration, otherwise it will reply withAskTimeoutException
in aStatus.Failure
param: interval duration after which next routee will be picked- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TailChoppingPool(int nr, java.time.Duration within, java.time.Duration interval)
Java APITailChoppingPool(int nr, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval)
Java APITailChoppingPool(int nrOfInstances, scala.Option<Resizer> resizer, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher, boolean usePoolDispatcher)
TailChoppingPool(com.typesafe.config.Config config)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static scala.Option<Resizer>
$lessinit$greater$default$2()
static SupervisorStrategy
$lessinit$greater$default$5()
static java.lang.String
$lessinit$greater$default$6()
static boolean
$lessinit$greater$default$7()
static TailChoppingPool
apply(int nrOfInstances, scala.Option<Resizer> resizer, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher, boolean usePoolDispatcher)
static scala.Option<Resizer>
apply$default$2()
static SupervisorStrategy
apply$default$5()
static java.lang.String
apply$default$6()
static boolean
apply$default$7()
boolean
canEqual(java.lang.Object x$1)
TailChoppingPool
copy(int nrOfInstances, scala.Option<Resizer> resizer, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher, boolean usePoolDispatcher)
int
copy$default$1()
scala.Option<Resizer>
copy$default$2()
scala.concurrent.duration.FiniteDuration
copy$default$3()
scala.concurrent.duration.FiniteDuration
copy$default$4()
SupervisorStrategy
copy$default$5()
java.lang.String
copy$default$6()
boolean
copy$default$7()
Router
createRouter(ActorSystem system)
Create the actual router, responsible for routing messages to routees.boolean
equals(java.lang.Object x$1)
int
hashCode()
scala.concurrent.duration.FiniteDuration
interval()
int
nrOfInstances()
int
nrOfInstances(ActorSystem sys)
Initial number of routee instancesint
productArity()
java.lang.Object
productElement(int x$1)
scala.collection.Iterator<java.lang.Object>
productIterator()
java.lang.String
productPrefix()
scala.Option<Resizer>
resizer()
Pool with dynamically resizable number of routees return theResizer
to use.java.lang.String
routerDispatcher()
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messagesSupervisorStrategy
supervisorStrategy()
SupervisorStrategy for the head actor, i.e.java.lang.String
toString()
static scala.Option<scala.Tuple7<java.lang.Object,scala.Option<Resizer>,scala.concurrent.duration.FiniteDuration,scala.concurrent.duration.FiniteDuration,SupervisorStrategy,java.lang.String,java.lang.Object>>
unapply(TailChoppingPool x$0)
boolean
usePoolDispatcher()
Use a dedicated dispatcher for the routees of the pool.TailChoppingPool
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 resizer and/or the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one, i.e.scala.concurrent.duration.FiniteDuration
within()
TailChoppingPool
withResizer(Resizer resizer)
Setting the resizer to be used.TailChoppingPool
withSupervisorStrategy(SupervisorStrategy strategy)
Setting the supervisor strategy to be used for the “head” 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, newRoutee, props, stopRouterWhenAllRouteesRemoved
-
Methods inherited from interface akka.routing.PoolOverrideUnsetConfig
overrideUnsetConfig
-
Methods inherited from interface akka.routing.RouterConfig
isManagementMessage, routingLogicController, verifyConfig
-
-
-
-
Constructor Detail
-
TailChoppingPool
public TailChoppingPool(int nrOfInstances, scala.Option<Resizer> resizer, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher, boolean usePoolDispatcher)
-
TailChoppingPool
public TailChoppingPool(com.typesafe.config.Config config)
-
TailChoppingPool
public TailChoppingPool(int nr, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval)
Java API- Parameters:
nr
- initial number of routees in the poolwithin
- expecting at least one reply within this duration, otherwise it will reply withAskTimeoutException
in aStatus.Failure
interval
- duration after which next routee will be picked
-
TailChoppingPool
public TailChoppingPool(int nr, java.time.Duration within, java.time.Duration interval)
Java API- Parameters:
nr
- initial number of routees in the poolwithin
- expecting at least one reply within this duration, otherwise it will reply withAskTimeoutException
in aStatus.Failure
interval
- duration after which next routee will be picked
-
-
Method Detail
-
$lessinit$greater$default$2
public static scala.Option<Resizer> $lessinit$greater$default$2()
-
$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 TailChoppingPool apply(int nrOfInstances, scala.Option<Resizer> resizer, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher, boolean usePoolDispatcher)
-
apply$default$2
public static scala.Option<Resizer> apply$default$2()
-
apply$default$5
public static SupervisorStrategy apply$default$5()
-
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>,scala.concurrent.duration.FiniteDuration,scala.concurrent.duration.FiniteDuration,SupervisorStrategy,java.lang.String,java.lang.Object>> unapply(TailChoppingPool 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 theResizer
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.
-
within
public scala.concurrent.duration.FiniteDuration within()
-
interval
public scala.concurrent.duration.FiniteDuration interval()
-
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 interfacePool
- 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 interfaceRouterConfig
- 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 interfacePool
- 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 interfaceRouterConfig
- Parameters:
system
- the ActorSystem this router belongs to- Returns:
- (undocumented)
-
nrOfInstances
public int nrOfInstances(ActorSystem sys)
Description copied from interface:Pool
Initial number of routee instances- Specified by:
nrOfInstances
in interfacePool
- Parameters:
sys
- (undocumented)- Returns:
- (undocumented)
-
withSupervisorStrategy
public TailChoppingPool withSupervisorStrategy(SupervisorStrategy strategy)
Setting the supervisor strategy to be used for the “head” Router actor.- Specified by:
withSupervisorStrategy
in interfacePoolOverrideUnsetConfig<TailChoppingPool>
- Parameters:
strategy
- (undocumented)- Returns:
- (undocumented)
-
withResizer
public TailChoppingPool withResizer(Resizer resizer)
Setting the resizer to be used.- Specified by:
withResizer
in interfacePoolOverrideUnsetConfig<TailChoppingPool>
- Parameters:
resizer
- (undocumented)- Returns:
- (undocumented)
-
withDispatcher
public TailChoppingPool 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 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.- Specified by:
withFallback
in interfaceRouterConfig
- Parameters:
other
- (undocumented)- Returns:
- (undocumented)
-
copy
public TailChoppingPool copy(int nrOfInstances, scala.Option<Resizer> resizer, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval, 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 scala.concurrent.duration.FiniteDuration copy$default$3()
-
copy$default$4
public scala.concurrent.duration.FiniteDuration copy$default$4()
-
copy$default$5
public SupervisorStrategy copy$default$5()
-
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 interfacescala.Product
-
productArity
public int productArity()
- Specified by:
productArity
in interfacescala.Product
-
productElement
public java.lang.Object productElement(int x$1)
- Specified by:
productElement
in interfacescala.Product
-
productIterator
public scala.collection.Iterator<java.lang.Object> productIterator()
- Specified by:
productIterator
in interfacescala.Product
-
canEqual
public boolean canEqual(java.lang.Object x$1)
- Specified by:
canEqual
in interfacescala.Equals
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object x$1)
- Specified by:
equals
in interfacescala.Equals
- Overrides:
equals
in classjava.lang.Object
-
-