Flow_meter (reference.progress.progress.engine.Progress_engine.Exposed_for_testing.Flow

Sourcetype 'a t

The type of flow meters for some metric: values that compute an online windowed integral of a discrete sequence of (value, time) samples. This is useful for e.g. estimating the download rate of a process given a sequence of progress updates.

Source

val create : 
  clock:(unit -> Mtime.t) ->
  size:int ->
  elt:(module Integer.S with type t = 'a) ->
  'a t

create ~clock ~size ~elt is a flow meter for values of type elt, using a window size of size and the clock function for collecting timestamps for recorded values.

Sourceval record : 'a t -> 'a -> unit

Add a value to the ring buffer.

Sourceval per_second : 'a t -> float

Estimate the rate of change of recorded values per second.