c

org.apache.pekko.routing

TailChoppingRoutingLogic

final case class TailChoppingRoutingLogic(scheduler: Scheduler, within: FiniteDuration, interval: FiniteDuration, context: ExecutionContext) extends RoutingLogic with Product with Serializable

As each message is sent to the router, 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 pool 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.

The goal of this routing algorithm is to decrease tail latencies ("chop off the tail latency") in situations where multiple routees can perform the same piece of work, and where a routee may occasionally respond more slowly than expected. In this case, sending the same work request (also known as a "backup request") to another actor results in decreased response time - because it's less probable that multiple actors are under heavy load simultaneously. This technique is explained in depth in Jeff Dean's presentation on Achieving Rapid Response Times in Large Online Services.

scheduler

schedules sending messages to routees

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

context

execution context used by scheduler

Annotations
@SerialVersionUID()
Source
TailChopping.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TailChoppingRoutingLogic
  2. Serializable
  3. Product
  4. Equals
  5. RoutingLogic
  6. NoSerializationVerificationNeeded
  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 TailChoppingRoutingLogic(scheduler: Scheduler, within: FiniteDuration, interval: FiniteDuration, context: ExecutionContext)

    scheduler

    schedules sending messages to routees

    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

    context

    execution context used by scheduler

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 TailChoppingRoutingLogic toany2stringadd[TailChoppingRoutingLogic] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TailChoppingRoutingLogic, B)
    Implicit
    This member is added by an implicit conversion from TailChoppingRoutingLogic toArrowAssoc[TailChoppingRoutingLogic] 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. val context: ExecutionContext
  9. def ensuring(cond: (TailChoppingRoutingLogic) => Boolean, msg: => Any): TailChoppingRoutingLogic
    Implicit
    This member is added by an implicit conversion from TailChoppingRoutingLogic toEnsuring[TailChoppingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (TailChoppingRoutingLogic) => Boolean): TailChoppingRoutingLogic
    Implicit
    This member is added by an implicit conversion from TailChoppingRoutingLogic toEnsuring[TailChoppingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): TailChoppingRoutingLogic
    Implicit
    This member is added by an implicit conversion from TailChoppingRoutingLogic toEnsuring[TailChoppingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): TailChoppingRoutingLogic
    Implicit
    This member is added by an implicit conversion from TailChoppingRoutingLogic toEnsuring[TailChoppingRoutingLogic] 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. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val scheduler: Scheduler
  22. def select(message: Any, routees: IndexedSeq[Routee]): Routee

    Pick the destination for a given message.

    Pick the destination for a given message. Normally it picks one of the passed routees, but in the end it is up to the implementation to return whatever pekko.routing.Routee to use for sending a specific message.

    When implemented from Java it can be good to know that routees.apply(index) can be used to get an element from the IndexedSeq.

    Definition Classes
    TailChoppingRoutingLogicRoutingLogic
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. 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 TailChoppingRoutingLogic toStringFormat[TailChoppingRoutingLogic] 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): (TailChoppingRoutingLogic, B)
    Implicit
    This member is added by an implicit conversion from TailChoppingRoutingLogic toArrowAssoc[TailChoppingRoutingLogic] 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from RoutingLogic

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTailChoppingRoutingLogic to any2stringadd[TailChoppingRoutingLogic]

Inherited by implicit conversion StringFormat fromTailChoppingRoutingLogic to StringFormat[TailChoppingRoutingLogic]

Inherited by implicit conversion Ensuring fromTailChoppingRoutingLogic to Ensuring[TailChoppingRoutingLogic]

Inherited by implicit conversion ArrowAssoc fromTailChoppingRoutingLogic to ArrowAssoc[TailChoppingRoutingLogic]

Ungrouped