c

org.apache.pekko.routing

TailChoppingGroup

final case class TailChoppingGroup(paths: Iterable[String], within: FiniteDuration, interval: FiniteDuration, routerDispatcher: String = Dispatchers.DefaultDispatcherId) extends Group with Product with 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 pekko.actor.Status.Failure wrapping a pekko.pattern.AskTimeoutException is sent to the sender.

Refer to pekko.routing.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.

paths

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

within

expecting at least one reply within this duration, otherwise it will reply with pekko.pattern.AskTimeoutException in a pekko.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

Source
TailChopping.scala
Linear Supertypes
Product, Equals, Group, RouterConfig, Serializable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TailChoppingGroup
  2. Product
  3. Equals
  4. Group
  5. RouterConfig
  6. Serializable
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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 pekko.actor.ActorSelection to these paths

    within

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

    interval

    duration after which next routee will be picked

  2. 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 pekko.actor.ActorSelection to these paths

    within

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

    interval

    duration after which next routee will be picked

  3. new TailChoppingGroup(config: Config)
  4. 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 pekko.actor.ActorSelection to these paths

    within

    expecting at least one reply within this duration, otherwise it will reply with pekko.pattern.AskTimeoutException in a pekko.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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from TailChoppingGroup toany2stringadd[TailChoppingGroup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TailChoppingGroup, B)
    Implicit
    This member is added by an implicit conversion from TailChoppingGroup toArrowAssoc[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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  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
    This member is added by an implicit conversion from TailChoppingGroup toEnsuring[TailChoppingGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (TailChoppingGroup) => Boolean): TailChoppingGroup
    Implicit
    This member is added by an implicit conversion from TailChoppingGroup toEnsuring[TailChoppingGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): TailChoppingGroup
    Implicit
    This member is added by an implicit conversion from TailChoppingGroup toEnsuring[TailChoppingGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): TailChoppingGroup
    Implicit
    This member is added by an implicit conversion from TailChoppingGroup toEnsuring[TailChoppingGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. val interval: FiniteDuration
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. 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
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def paths(system: ActorSystem): Iterable[String]
    Definition Classes
    TailChoppingGroup → Group
  22. val paths: Iterable[String]
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. def props(): Props

    pekko.actor.Props for a group router based on the settings defined by this instance.

    pekko.actor.Props for a group router based on the settings defined by this instance.

    Definition Classes
    Group
  25. 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
    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. Management messages not handled by the "head" actor are delegated to this controller actor.

    Definition Classes
    RouterConfig
  27. def stopRouterWhenAllRouteesRemoved: Boolean

    Specify that this router should stop itself when all routees have terminated (been removed).

    Specify that this router should stop itself when all routees have terminated (been removed). By Default it is true, unless a resizer is used.

    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(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TailChoppingGroup toStringFormat[TailChoppingGroup] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (TailChoppingGroup, B)
    Implicit
    This member is added by an implicit conversion from TailChoppingGroup toArrowAssoc[TailChoppingGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Product

Inherited from Equals

Inherited from Group

Inherited from RouterConfig

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTailChoppingGroup to any2stringadd[TailChoppingGroup]

Inherited by implicit conversion StringFormat fromTailChoppingGroup to StringFormat[TailChoppingGroup]

Inherited by implicit conversion Ensuring fromTailChoppingGroup to Ensuring[TailChoppingGroup]

Inherited by implicit conversion ArrowAssoc fromTailChoppingGroup to ArrowAssoc[TailChoppingGroup]

Ungrouped