akka.routing

Class TailChoppingGroup

java.lang.Object

akka.routing.TailChoppingGroup

All Implemented Interfaces:

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

public final class TailChoppingGroup
extends java.lang.Object
implements Group, scala.Product, scala.Serializable

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 interval has 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 the within duration has passed since the first send. If no routee sends a response in time, a Status.Failure wrapping a AskTimeoutException is sent to the sender.

Refer to TailChoppingRoutingLogic for comments regarding the goal of this routing algorithm.

The configuration parameter trumps the constructor arguments. This means that if you provide paths during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.

param: paths string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths

param: within expecting at least one reply within this duration, otherwise it will reply with AskTimeoutException in a Status.Failure

param: interval duration after which the message will be sent to the next routee

param: routerDispatcher dispatcher to use for the router head actor, which handles router management messages

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TailChoppingGroup(com.typesafe.config.Config config)
TailChoppingGroup(java.lang.Iterable<java.lang.String> routeePaths, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval) Java API
TailChoppingGroup(scala.collection.immutable.Iterable<java.lang.String> paths, scala.concurrent.duration.FiniteDuration within, scala.concurrent.duration.FiniteDuration interval, java.lang.String routerDispatcher)

Method Summary

Modifier and Type	Method and Description
abstract static boolean	canEqual(java.lang.Object that)
Router	createRouter(ActorSystem system) Create the actual router, responsible for routing messages to routees.
static RouterActor	createRouterActor()
abstract static boolean	equals(java.lang.Object that)
scala.concurrent.duration.FiniteDuration	interval()
static boolean	isManagementMessage(java.lang.Object msg)
scala.collection.immutable.Iterable<java.lang.String>	paths()
scala.collection.immutable.Iterable<java.lang.String>	paths(ActorSystem system)
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
static Props	props()
static Routee	routeeFor(java.lang.String path, ActorContext context)
java.lang.String	routerDispatcher() Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
static scala.Option<Props>	routingLogicController(RoutingLogic routingLogic)
static boolean	stopRouterWhenAllRouteesRemoved()
static void	verifyConfig(ActorPath path)
TailChoppingGroup	withDispatcher(java.lang.String dispatcherId) Setting the dispatcher to be used for the router head actor, which handles router management messages
static RouterConfig	withFallback(RouterConfig other)
scala.concurrent.duration.FiniteDuration	within()

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.routing.Group

createRouterActor, props, routeeFor

Methods inherited from interface akka.routing.RouterConfig

isManagementMessage, routingLogicController, stopRouterWhenAllRouteesRemoved, verifyConfig, withFallback

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

TailChoppingGroup

public TailChoppingGroup(scala.collection.immutable.Iterable<java.lang.String> paths,
                         scala.concurrent.duration.FiniteDuration within,
                         scala.concurrent.duration.FiniteDuration interval,
                         java.lang.String routerDispatcher)

TailChoppingGroup

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

TailChoppingGroup

public TailChoppingGroup(java.lang.Iterable<java.lang.String> routeePaths,
                         scala.concurrent.duration.FiniteDuration within,
                         scala.concurrent.duration.FiniteDuration interval)

Java API

Parameters:

routeePaths - string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths

within - expecting at least one reply within this duration, otherwise it will reply with AskTimeoutException in a Status.Failure

interval - duration after which next routee will be picked

Method Detail

routingLogicController

public static scala.Option<Props> routingLogicController(RoutingLogic routingLogic)

isManagementMessage

public static boolean isManagementMessage(java.lang.Object msg)

stopRouterWhenAllRouteesRemoved

public static boolean stopRouterWhenAllRouteesRemoved()

withFallback

public static RouterConfig withFallback(RouterConfig other)

verifyConfig

public static void verifyConfig(ActorPath path)

props

public static Props props()

routeeFor

public static Routee routeeFor(java.lang.String path,
                               ActorContext context)

createRouterActor

public static RouterActor createRouterActor()

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

paths

public scala.collection.immutable.Iterable<java.lang.String> paths()

Specified by:

paths in interface Group

within

public scala.concurrent.duration.FiniteDuration within()

interval

public scala.concurrent.duration.FiniteDuration interval()

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)

paths

public scala.collection.immutable.Iterable<java.lang.String> paths(ActorSystem system)

Specified by:

paths in interface Group

withDispatcher

public TailChoppingGroup withDispatcher(java.lang.String dispatcherId)

Setting the dispatcher to be used for the router head actor, which handles router management messages

Parameters:

dispatcherId - (undocumented)

Returns:

(undocumented)