package luv

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

Signals.

See Signals in the user guide and uv_signal_t — Signal handle in libuv.

Interface

type t = [ `Signal ] Handle.t

Binds uv_signal_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) Stdlib.result

Allocates and initializes a signal handle.

Binds uv_signal_init.

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

Starts the signal handle.

Binds uv_signal_start.

See Signal numbers below for possible values of the integer argument.

val start_oneshot : t -> int -> (unit -> unit) -> (unit, Error.t) Stdlib.result

Like Luv.Signal.start, but the handle is stopped after one callback call.

Binds uv_signal_start_oneshot.

Requires libuv 1.12.0.

Feature check: Luv.Require.(has signal_start_oneshot)

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

Stops the signal handle.

Binds uv_signal_stop.

val signum : t -> int

Evaluates to the signal number associated with the handle.

Binds uv_signal_t.signum.

Signal numbers

For the moment, the signals exposed are those that are both present on Unix and present or emulated by libuv on Windows. See Windows notes and Unix notes.

Note that these signal numbers do not, in general, match the ones in module Sys in the OCaml standard library.

val sigabrt : int
val sigfpe : int
val sighup : int
val sigill : int
val sigint : int
val sigkill : int
val sigsegv : int
val sigterm : int
val sigwinch : int
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