akka.routing

TailChoppingGroup

Related Doc: package routing

final case class TailChoppingGroup(paths: Iterable[String], within: FiniteDuration, interval: FiniteDuration, routerDispatcher: String = Dispatchers.DefaultDispatcherId) extends Group with Product with Serializable

A router group that sends the message to a first, random picked, routee, then wait a specified interval and then send to a second, random picked, and so on till one full cycle..

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.

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 akka.pattern.AskTimeoutException in a akka.actor.Status.Failure

interval

duration after which next routee will be picked

routerDispatcher

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

Source
TailChopping.scala
Linear Supertypes
Product, Equals, Group, RouterConfig, Serializable, Serializable, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TailChoppingGroup
  2. Product
  3. Equals
  4. Group
  5. RouterConfig
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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 akka.pattern.AskTimeoutException in a akka.actor.Status.Failure

    interval

    duration after which next routee will be picked

  2. new TailChoppingGroup(config: Config)

  3. 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 akka.pattern.AskTimeoutException in a akka.actor.Status.Failure

    interval

    duration after which next routee will be picked

    routerDispatcher

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from TailChoppingGroup to any2stringadd[TailChoppingGroup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (TailChoppingGroup, B)

    Implicit information
    This member is added by an implicit conversion from TailChoppingGroup to ArrowAssoc[TailChoppingGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. 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
    TailChoppingGroup → RouterConfig

  9. def ensuring(cond: (TailChoppingGroup) ⇒ Boolean, msg: ⇒ Any): TailChoppingGroup

    Implicit information
    This member is added by an implicit conversion from TailChoppingGroup to Ensuring[TailChoppingGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (TailChoppingGroup) ⇒ Boolean): TailChoppingGroup

    Implicit information
    This member is added by an implicit conversion from TailChoppingGroup to Ensuring[TailChoppingGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): TailChoppingGroup

    Implicit information
    This member is added by an implicit conversion from TailChoppingGroup to Ensuring[TailChoppingGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): TailChoppingGroup

    Implicit information
    This member is added by an implicit conversion from TailChoppingGroup to Ensuring[TailChoppingGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from TailChoppingGroup to StringFormat[TailChoppingGroup] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. val interval: FiniteDuration

    duration after which next routee will be picked

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. 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

  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  23. val paths: Iterable[String]

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

    Definition Classes
    TailChoppingGroup → Group

  24. 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

  25. val routerDispatcher: String

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

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

    Definition Classes
    TailChoppingGroup → RouterConfig

  26. def routingLogicController(routingLogic: RoutingLogic): Option[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. Managment messages not handled by the "head" actor are delegated to this controller actor.

    Definition Classes
    RouterConfig

  27. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    RouterConfig

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  29. 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

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. def withDispatcher(dispatcherId: String): TailChoppingGroup

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

  34. 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

  35. val within: FiniteDuration

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

  36. def →[B](y: B): (TailChoppingGroup, B)

    Implicit information
    This member is added by an implicit conversion from TailChoppingGroup to ArrowAssoc[TailChoppingGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Product

Inherited from Equals

Inherited from Group

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from TailChoppingGroup to any2stringadd[TailChoppingGroup]

Inherited by implicit conversion StringFormat from TailChoppingGroup to StringFormat[TailChoppingGroup]

Inherited by implicit conversion Ensuring from TailChoppingGroup to Ensuring[TailChoppingGroup]

Inherited by implicit conversion ArrowAssoc from TailChoppingGroup to ArrowAssoc[TailChoppingGroup]

Ungrouped