package luv

  1. Overview
  2. Docs
package luv
Legend:
Library
Module
Module type
Parameter
Class
Class type

Per-iteration callback.

See Example in the user guide and uv_idle_t — Idle handle in libuv.

type t = [ `Idle ] Handle.t

Binds uv_idle_t.

Note that values of this type can be passed to functions in Luv.Handle, in addition to the functions in this module. In particular, see Luv.Handle.close.

val init : ?loop:Loop.t -> unit -> (t, Error.t) result

Allocates and initializes an idle handle.

Binds uv_idle_init.

The handle should be cleaned up with Luv.Handle.close when no longer needed.

val start : t -> (unit -> unit) -> (unit, Error.t) result

Starts the handle with the given callback.

Binds uv_idle_start.

val stop : t -> (unit, Error.t) result

Stops the handle.

Binds uv_idle_stop.

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