Package

upperbound

Permalink

package upperbound

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. upperbound
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class BackPressure[F[_], A] extends AnyRef

    Permalink

    Adds the ability to apply backpressure to the Limiter.

    Adds the ability to apply backpressure to the Limiter.

    The ack parameter can be used to signal to the Limiter that backpressure should be applied depending on the result of job. Note that this will only change the processing rate: it won't do any error handling for you.

    Every time a job signals backpressure is needed, the Limiter will adjust its current rate by applying backOff to it. This means the rate will be adjusted by calling backOff repeatedly whenever multiple consecutive jobs signal for backpressure, and reset to its original value when a job signals backpressure is no longer needed.

    Note that since jobs submitted to the Limiter are processed asynchronously, rate changes might not propagate instantly when the rate is smaller than the job completion time. However, the rate will eventually converge to its most up-to-date value.

    Also see syntax.backpressure

  2. type LimitReachedException = upperbound.Limiter.LimitReachedException

    Permalink
  3. trait Limiter[F[_]] extends AnyRef

    Permalink

    A purely functional, interval based rate limiter.

  4. case class Rate(n: Int, t: FiniteDuration) extends Product with Serializable

    Permalink

    Models the job processing rate Also see syntax.rate

Value Members

  1. object BackPressure

    Permalink
  2. val LimitReachedException: upperbound.Limiter.LimitReachedException.type

    Permalink
  3. object Limiter

    Permalink
  4. object Rate extends Serializable

    Permalink
  5. object syntax

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped