c

akka.util

NanoTimeTokenBucket

final class NanoTimeTokenBucket extends TokenBucket

Default implementation of TokenBucket that uses System.nanoTime as the time source.

Source
TokenBucket.scala
Linear Supertypes
TokenBucket, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NanoTimeTokenBucket
  2. TokenBucket
  3. AnyRef
  4. 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 NanoTimeTokenBucket(_cap: Long, _period: Long)

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

    The current time in nanos.

    The current time in nanos. The returned value is monotonic, might wrap over and has no relationship with wall-clock.

    returns

    return the current time in nanos as a Long.

    Definition Classes
    NanoTimeTokenBucket → TokenBucket
  9. def ensuring(cond: (NanoTimeTokenBucket) ⇒ Boolean, msg: ⇒ Any): NanoTimeTokenBucket
    Implicit
    This member is added by an implicit conversion from NanoTimeTokenBucket to Ensuring[NanoTimeTokenBucket] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (NanoTimeTokenBucket) ⇒ Boolean): NanoTimeTokenBucket
    Implicit
    This member is added by an implicit conversion from NanoTimeTokenBucket to Ensuring[NanoTimeTokenBucket] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): NanoTimeTokenBucket
    Implicit
    This member is added by an implicit conversion from NanoTimeTokenBucket to Ensuring[NanoTimeTokenBucket] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): NanoTimeTokenBucket
    Implicit
    This member is added by an implicit conversion from NanoTimeTokenBucket to Ensuring[NanoTimeTokenBucket] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NanoTimeTokenBucket to StringFormat[NanoTimeTokenBucket] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def init(): Unit

    This method must be called before the token bucket can be used.

    This method must be called before the token bucket can be used.

    Definition Classes
    TokenBucket
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def offer(cost: Long): Long

    Call this (side-effecting) method whenever an element should be passed through the token-bucket.

    Call this (side-effecting) method whenever an element should be passed through the token-bucket. This method will return the number of nanoseconds the element needs to be delayed to conform with the token bucket parameters. Returns zero if the element can be emitted immediately. The method does not handle overflow, if an element is to be delayed longer in nanoseconds than what can be represented as a positive Long then an undefined value is returned.

    If a non-zero value is returned, it is the responsibility of the caller to not call this method before the returned delay has been elapsed (but can be called later). This class does not check or protect against early calls.

    cost

    How many tokens the element costs. Can be larger than the capacity of the bucket.

    Definition Classes
    TokenBucket
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  30. def [B](y: B): (NanoTimeTokenBucket, B)
    Implicit
    This member is added by an implicit conversion from NanoTimeTokenBucket to ArrowAssoc[NanoTimeTokenBucket] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from TokenBucket

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped