final case class TailChoppingGroup(paths: Iterable[String], within: FiniteDuration, interval: FiniteDuration, routerDispatcher: String = Dispatchers.DefaultDispatcherId) extends Group with Product with Serializable
- Alphabetic
- By Inheritance
- TailChoppingGroup
- Product
- Equals
- Group
- RouterConfig
- Serializable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TailChoppingGroup(routeePaths: Iterable[String], within: Duration, interval: Duration)
Java API
Java API
- routeePaths
string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths
- within
expecting at least one reply within this duration, otherwise it will reply with in a akka.actor.Status.Failure
- interval
duration after which next routee will be picked
- new TailChoppingGroup(routeePaths: Iterable[String], within: FiniteDuration, interval: FiniteDuration)
Java API
Java API
- routeePaths
string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths
- within
expecting at least one reply within this duration, otherwise it will reply with in a akka.actor.Status.Failure
- interval
duration after which next routee will be picked
- new TailChoppingGroup(config: Config)
- new TailChoppingGroup(paths: Iterable[String], within: FiniteDuration, interval: FiniteDuration, routerDispatcher: String = Dispatchers.DefaultDispatcherId)
- paths
string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths
- within
expecting at least one reply within this duration, otherwise it will reply with in a akka.actor.Status.Failure
- interval
duration after which the message will be sent to the next routee
- routerDispatcher
dispatcher to use for the router head actor, which handles router management messages
Value Members
- def createRouter(system: ActorSystem): Router
Create the actual router, responsible for routing messages to routees.
Create the actual router, responsible for routing messages to routees.
- system
the ActorSystem this router belongs to
- Definition Classes
- → RouterConfig
- val interval: FiniteDuration
- def isManagementMessage(msg: Any): Boolean
Is the message handled by the router head actor or the #routingLogicController actor.
Is the message handled by the router head actor or the #routingLogicController actor.
- Definition Classes
- RouterConfig
- def paths(system: ActorSystem): Iterable[String]
- Definition Classes
- → Group
- val paths: Iterable[String]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def props(): Props
akka.actor.Props for a group router based on the settings defined by this instance.
akka.actor.Props for a group router based on the settings defined by this instance.
- Definition Classes
- Group
- val routerDispatcher: String
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages
- Definition Classes
- → RouterConfig
- def routingLogicController(routingLogic: RoutingLogic): [Props]
Possibility to define an actor for controlling the routing logic from external stimuli (e.g.
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.
- Definition Classes
- RouterConfig
- def stopRouterWhenAllRouteesRemoved: Boolean
- Definition Classes
- RouterConfig
- def verifyConfig(path: ActorPath): Unit
Check that everything is there which is needed.
Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.
- Definition Classes
- RouterConfig
- def withDispatcher(dispatcherId: String): TailChoppingGroup
Setting the dispatcher to be used for the router head actor, which handles router management messages
- def withFallback(other: RouterConfig): RouterConfig
Overridable merge strategy, by default completely prefers
this(i.e.Overridable merge strategy, by default completely prefers
this(i.e. no merge).- Definition Classes
- RouterConfig
- val within: FiniteDuration
A router group with retry logic, intended for cases where a return message is expected in response to a message sent to the routee. As each message is sent to the routing group, the routees are randomly ordered. The message is sent to the first routee. If no response is received before the
intervalhas passed, the same message is sent to the next routee. This process repeats until either a response is received from some routee, the routees in the group are exhausted, or thewithinduration has passed since the first send. If no routee sends a response in time, a akka.actor.Status.Failure wrapping a akka.pattern.AskTimeoutException is sent to the sender.Refer to akka.routing.TailChoppingRoutingLogic for comments regarding the goal of this routing algorithm.
The configuration parameter trumps the constructor arguments. This means that if you provide
pathsduring instantiation they will be ignored if the router is defined in the configuration file for the actor being used.string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths
expecting at least one reply within this duration, otherwise it will reply with akka.pattern.AskTimeoutException in a akka.actor.Status.Failure
duration after which the message will be sent to the next routee
dispatcher to use for the router head actor, which handles router management messages