package vlt

  1. Overview
  2. Docs

Module Vlt.SignalSource

This module provides support for signal handling.

Sourcetype t =
  1. | HUP
    (*

    Equivalent to Sys.sighup.

    *)
  2. | USR1
    (*

    Equivalent to Sys.sigusr1.

    *)
  3. | USR2
    (*

    Equivalent to Sys.sigusr2.

    *)

The type of signal that can trigger log rotate.

Sourcetype error =
  1. | Invalid_signal_string of string
  2. | Invalid_signal_int of int
  3. | Invalid_signal_sys of int
Sourceexception Exception of error
Sourceval of_string : string -> t

Converts a string into a signal.

Raises Exception if the passed string is invalid.

Sourceval to_sys : t -> int

Converts a signal into its Sys equivalent.

Sourceval of_sys : int -> t

Converts a Sys integer code into a signal.

Raises Exception if the passed integer is invalid.

Sourceval to_int : t -> int

Converts a signal into an integer between 0 and max_int - 1.

Sourceval of_int : int -> t

Converts an integer into a signal.

Raises Exception if the passed integer is invalid (below 0, or above or equal to max_int).

Sourceval max_int : int

Maximal integer value for a signal.