package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type
type nonrec t = private t
val sexp_of_t : t -> Sexplib0.Sexp.t
val create_exn : now:Core.Time_ns.t -> burst_size:int -> sustained_rate_per_sec:float -> t

A Token_bucket.Starts_full.t is a Token_bucket.t that is statically guaranteed to have been called with initial_bucket_level equal to burst_size. The advantage of such a guarantee is that there's a clear semantics for increasing the bucket limit (implemented in try_increase_bucket_limit).

This is not to say that other subtypes of Limiter.t don't have reasonable semantics for increasing their limits in some way, but Limiter.t is general enough that they should probably be considered on a case-by-case basis.

val try_reconfigure : t -> burst_size:int -> sustained_rate_per_sec:float -> allow_limit_decrease:bool -> Try_reconfigure_result.t

Increases the bucket_limit and the current bucket_level by the difference between the current and new bucket limits. Decreasing the bucket_limit may cause the bucket_level to become negative, breaking an invariant. If the new limit would cause bucket_level to become negative, Unable is returned.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct