com.datastax.spark.connector.writer

RateLimiter

class RateLimiter extends AnyRef

A leaking bucket rate limiter. It can be used to limit rate of anything, but typically it is used to limit rate of data transfer.

It starts with an empty bucket. When packets arrive, they are added to the bucket. The bucket has a constant size and is leaking at a constant rate. If the bucket overflows, the thread is delayed by the amount of time proportional to the amount of the overflow.

This class is thread safe and lockless.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RateLimiter
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RateLimiter(rate: Long, bucketSize: Long, time: () ⇒ Long = ..., sleep: (Long) ⇒ Any = ...)

    rate

    maximum allowed long-term rate per 1000 units of time

    bucketSize

    maximum acceptable "burst"

    time

    source of time; typically 1 unit = 1 ms

    sleep

    a function to call to slow down the calling thread; must use the same time units as time

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from RateLimiter to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (RateLimiter, B)

    Implicit information
    This member is added by an implicit conversion from RateLimiter to ArrowAssoc[RateLimiter] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (RateLimiter) ⇒ Boolean, msg: ⇒ Any): RateLimiter

    Implicit information
    This member is added by an implicit conversion from RateLimiter to Ensuring[RateLimiter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (RateLimiter) ⇒ Boolean): RateLimiter

    Implicit information
    This member is added by an implicit conversion from RateLimiter to Ensuring[RateLimiter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): RateLimiter

    Implicit information
    This member is added by an implicit conversion from RateLimiter to Ensuring[RateLimiter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): RateLimiter

    Implicit information
    This member is added by an implicit conversion from RateLimiter to Ensuring[RateLimiter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from RateLimiter to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def maybeSleep(packetSize: Long): Unit

    Processes a single packet.

    Processes a single packet. If the packet is bigger than the current amount of space available in the bucket, this method will sleep for appropriate amount of time, in order to not exceed the target rate.

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

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  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
    @throws( ... )
  30. def [B](y: B): (RateLimiter, B)

    Implicit information
    This member is added by an implicit conversion from RateLimiter to ArrowAssoc[RateLimiter] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from RateLimiter to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (rateLimiter: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from RateLimiter to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (rateLimiter: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: RateLimiter

    Implicit information
    This member is added by an implicit conversion from RateLimiter to ArrowAssoc[RateLimiter] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (rateLimiter: ArrowAssoc[RateLimiter]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: RateLimiter

    Implicit information
    This member is added by an implicit conversion from RateLimiter to Ensuring[RateLimiter] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (rateLimiter: Ensuring[RateLimiter]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from RateLimiter to StringAdd

Inherited by implicit conversion any2stringfmt from RateLimiter to StringFormat

Inherited by implicit conversion any2ArrowAssoc from RateLimiter to ArrowAssoc[RateLimiter]

Inherited by implicit conversion any2Ensuring from RateLimiter to Ensuring[RateLimiter]

Ungrouped