RateLimiter

Object Hierarchy:

Description:

    var created = RateLimiter.of (100);
    if (created.isError ()) {
        return;
    }
    var limiter = created.unwrap ();
    var configured = limiter.withBurst (200);
    if (configured.isError ()) {
        return;
    }

    if (limiter.allow ()) {
        send_request ();
    }

Content:

Static methods:

• public static Result<RateLimiter,Error> of (int permitsPerSecond)
  Creates a new rate limiter.

Methods:

• public bool allow ()
  Tries to acquire one permit immediately.
• public Result<bool,Error> allowN (int permits)
  Tries to acquire n permits immediately.
• public int availableTokens ()
  Returns currently available permits (floored).
• public int64 reserve ()
  Returns estimated wait milliseconds until one permit becomes available.
• public void reset ()
  Resets current tokens to burst capacity.
• public Result<bool,Error> setRate (int permitsPerSecond)
  Updates rate.
• public void wait ()
  Waits until one permit is available and acquires it.
• public Result<bool,Error> waitN (int permits)
  Waits until n permits are available and acquires them.
• public Result<RateLimiter,Error> withBurst (int permits)
  Sets burst capacity.

Inherited Members: