Class Throttler.Rate

  extended by akka.contrib.throttle.Throttler.Rate
All Implemented Interfaces:
java.io.Serializable, scala.Equals, scala.Product
Enclosing class:

public static class Throttler.Rate
extends java.lang.Object
implements scala.Product, scala.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

param: numberOfCalls the number of calls that may take place in a period param: duration the length of the period

See Also:
Throttler, Serialized Form

Constructor Summary
Throttler.Rate(int numberOfCalls, scala.concurrent.duration.FiniteDuration duration)
Method Summary
 scala.concurrent.duration.FiniteDuration duration()
 long durationInMillis()
          The duration in milliseconds.
 int numberOfCalls()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface scala.Product
productArity, productElement, productIterator, productPrefix
Methods inherited from interface scala.Equals
canEqual, equals

Constructor Detail


public Throttler.Rate(int numberOfCalls,
                      scala.concurrent.duration.FiniteDuration duration)
Method Detail


public int numberOfCalls()


public scala.concurrent.duration.FiniteDuration duration()


public long durationInMillis()
The duration in milliseconds.