Up

Module Token_bucket

Signature

type t
val sexp_of_t : t -> Sexplib.Sexp.t
val create_exn : burst_size:float -> sustained_rate_per_sec:float -> continue_on_error:bool -> ?in_flight_limit:float -> ?initial_burst_size:float -> unit -> t
val enqueue_exn : t -> ?allow_immediate_run:bool -> float -> ('a -> unit) -> 'a -> unit

enqueue_exn t x f a enqueues an immediate job consuming x tokens, running f on input a.

if allow_immediate_run is true then f is allowed to run within the same async job as enqueue_exn iff there are enough tokens available to fully run the job and there are no other previously enqueued jobs that have not run. If this is the case, it is run before enqueue_exn returns. Otherwise no part of f is run before enqueue_exn returns.

If there is a failure associated with this job then the exception will be raised to the monitor in scope when enqueue_exn is called. Note that it may fail for a number of reasons, including f throws an exception, the limiter is killed, or the number of tokens requested is larger than the burst size.

val enqueue' : t -> float -> ('a -> 'b Async_extra.Import.Deferred.t) -> 'a -> 'b Outcome.t Async_extra.Import.Deferred.t

enqueue' t x f a enqueues a deferred job consuming x tokens, running f on input a. No part of f is run before enqueue' returns.

type 'a u = t
include Common with type 'a t := 'a u
type _ t
val kill : _ t -> unit

kills t, which aborts all enqueued jobs that haven't started and all jobs enqueued in the future. If t has already been killed, then calling kill t has no effect. Note that kill does not effect currently running jobs in any way.

val is_dead : _ t -> bool

is_dead t returns true if t was killed, either by kill or by an unhandled exception in a job.

val to_limiter : _ t -> limiter

Convert to a limiter