package lwt

  1. Overview
  2. Docs
Promises and event-driven I/O

Install

Dune Dependency

Authors

Maintainers

Sources

5.0.1.tar.gz
sha256=b54c78ef2b7a47c94d6ef8c93333b474b2f8ad912f9208cc94dbca44612e9fc9
md5=70d107a5ff1247840e8012b6a3793c15

doc/lwt.unix/Lwt_throttle/module-type-S/index.html

Module type Lwt_throttle.S

type key
type t
val create : rate:int -> max:int -> n:int -> t

Creates a rate limiter.

  • parameter rate

    Maximum number of promise resolutions per second, per channel.

  • parameter max

    Maximum number of pending promises allowed at once, over all channels.

  • parameter n

    Initial size of the internal channel hash table. This should be approximately the number of different channels that will be used.

val wait : t -> key -> bool Lwt.t

Lwt_throttle.wait limiter channel returns a new promise associated with the given rate limiter and channel.

If the maximum number of pending promises for limiter has not been reached, the promise starts pending. It will be resolved with true at some future time, such that the rate limit of limiter is not exceeded, with respect to other promises in the same channel.

If the maximum number of pending promises has been reached, the returned promise is already resolved with false.

OCaml

Innovation. Community. Security.