Trait/Object

upperbound

Limiter

Related Docs: object Limiter | package upperbound

Permalink

trait Limiter[F[_]] extends AnyRef

A purely functional, interval based rate limiter.

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

Abstract Value Members

  1. abstract def initial: FiniteDuration

    Permalink

    The interval set on creation of this Limiter

  2. abstract def interval: SignallingRef[F, FiniteDuration]

    Permalink

    Allows to sample, change or react to changes to the current interval between two tasks.

  3. abstract def pending: F[Int]

    Permalink

    Obtains a snapshot of the current number of jobs waiting to be executed.

    Obtains a snapshot of the current number of jobs waiting to be executed. May be out of date the instant after it is retrieved.

  4. abstract def submit[A](job: F[A], priority: Int = 0): F[Unit]

    Permalink

    Returns an F[Unit] which represents the action of submitting job to the limiter with the given priority.

    Returns an F[Unit] which represents the action of submitting job to the limiter with the given priority. A higher number means a higher priority. The default is 0.

    The semantics of submit are fire-and-forget: the returned F[Unit] immediately returns, without waiting for the F[A] to complete its execution. Note that this means that the returned F[Unit] will be successful regardless of whether job fails or not.

    This method is designed to be called concurrently: every concurrent call submits a job, and they are all started at a rate which is no higher then the maximum rate you specify when constructing a Limiter. Higher priority jobs take precedence over lower priority ones.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped