Packages

final case class Rate(numberOfCalls: Int, duration: FiniteDuration) extends Product with Serializable

A rate used for throttling.

Scala API: There are some shorthands available to construct rates:

import java.util.concurrent.TimeUnit._
import scala.concurrent.duration.{ Duration, FiniteDuration }

val rate1 = 1 msgsPer (1, SECONDS)
val rate2 = 1 msgsPer Duration(1, SECONDS)
val rate3 = 1 msgsPer (1 seconds)
val rate4 = 1 msgsPerSecond
val rate5 = 1 msgsPerMinute
val rate6 = 1 msgsPerHour
numberOfCalls

the number of calls that may take place in a period

duration

the length of the period

Source
TimerBasedThrottler.scala
See also

akka.contrib.throttle.Throttler

Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Rate
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Rate(numberOfCalls: Int, duration: FiniteDuration)

    numberOfCalls

    the number of calls that may take place in a period

    duration

    the length of the period

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 Rate to any2stringadd[Rate] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Rate, B)
    Implicit
    This member is added by an implicit conversion from Rate to ArrowAssoc[Rate] 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
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  8. val duration: FiniteDuration
  9. def durationInMillis(): Long

    The duration in milliseconds.

  10. def ensuring(cond: (Rate) ⇒ Boolean, msg: ⇒ Any): Rate
    Implicit
    This member is added by an implicit conversion from Rate to Ensuring[Rate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Rate) ⇒ Boolean): Rate
    Implicit
    This member is added by an implicit conversion from Rate to Ensuring[Rate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): Rate
    Implicit
    This member is added by an implicit conversion from Rate to Ensuring[Rate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Rate
    Implicit
    This member is added by an implicit conversion from Rate to Ensuring[Rate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Rate to StringFormat[Rate] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. val numberOfCalls: Int
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def [B](y: B): (Rate, B)
    Implicit
    This member is added by an implicit conversion from Rate to ArrowAssoc[Rate] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped