jon.recoil.org

Module Domain.TickSource

type t : mutable_data mod external_ global

A handle to a request that the tick thread tick at a given interval

In between calling acquire and calling release, the tick thread will tick at least as frequently as the provided interval_usec.

val acquire : interval_usec:int -> t @ unique @@ portable

Request that the tick thread tick at least as frequently as tick_interval until release is called on the returned handle.

val release : t @ unique -> unit @@ portable

Release a handle to a tick request.

It is unsound to call this on a domain other than the one that called acquire (though it is fine to call it on a different thread on the same domain).

Sourceval effective_interval_usec : unit -> int or_null @@ portable

Returns the interval at which the tick thread will tick, or Null if no domain has any active tick requests. This is the global minimum across all domains of live tick requests.