/usr/lib/ocaml/netsys/netsys_signal.mli is in libocamlnet-ocaml-dev 4.0.4-1build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | (* $Id: netsys_signal.mli 2195 2015-01-01 12:23:39Z gerd $ *)
(** Signal handler framework
This module defines a simple framework for setting signal handlers.
When two modules want to set the handler for the same signal, the framework
decides in which order the handlers are executed.
The module also defines an empty handler for [Sys.sigpipe], so this
signal is ignored by the program (and you get a
[Unix.Unix_error(EPIPE,_,_)] exception instead).
{b If you don't like that Netsys sets the Sigpipe handler, you can undo
this:}
{[
Sys.set_signal Sys.sigpipe Sys.Signal_default;;
Netsys_signal.keep_away_from Sys.sigpipe;;
]}
{b Win32:} Only [Sys.sigint] handlers can effectively be registered.
Registrations for other signal types are accepted but ignored.
*)
(* Win32: The Ocaml runtime makes a bad joke, and uses SIGTERM for
interrupting the running program from the tick thread
*)
val register_handler :
?library:string ->
?priority:int ->
?keep_default:bool ->
name: string ->
signal: int ->
callback:(int -> unit)->
unit -> unit
(** This function registers a handler called [name] for signal number
[signal]. The handler function is [callback]. The int argument of
the callback is the signal number.
By default, the handler is an application handler. If [library] is set,
the handler is for this library. The name passed as [library] is the
findlib name of the library.
By registering another handler for the same [library], [name], and
[signal], the old handler is overridden.
When several handlers are defined for the same signal, all handlers
are executed that are defined for the signal (when the signal happens).
The order of execution is given by [priority]. The handler functions
are executed in ascending priority order. If the priority number is
equal for two handlers, the order is undefined.
The priority defaults to 0 for library handlers, and to 100 for
application handlers. Libraries should only use values from 0 to 99,
and applications only from 100 to 199.
If all handlers for a certain signal set [keep_default], then there
will be a special action after all signal handlers have been executed.
The special action emulates the default behavior for the signal.
For now, there is only a simple emulation: If the signal terminates
the process, the process is immediately exited with code 126.
If the default behaviour is "no-op", nothing happens. We don't try
(yet) to do better (emulate core-dumps, emulate the right process
status) because this is difficult in the general case.
The handler definition takes place immediately.
Any exceptions occuring during the execution of a handler are caught
and ignored.
*)
val register_exclusive_handler :
name: string ->
signal: int ->
install:(unit -> unit)->
unit -> unit
(** An exclusive handler for a signal is the only handler for the signal.
If it is tried to register another handler when there is already
an exclusive handler, the second registration fails. Also, an
exclusive handler cannot be registered when there is already a normal
handler for the signal. It is, however, possible to replace the
registered exclusive handler by another exclusive handler for the
same signal.
An exclusive handler is installed by running the [install] function,
which can e.g. call [Sys.set_signal] to define the handler. Other
methods (e.g. use some C wrapper) are also possible. It is assumed
that [install] overrides any existing handler.
*)
val restore_management : int -> unit
(** [restore_management signo]: Restores signal handling management for
[signo] as defined by
the handler list for this signal. Calling [restore_management] makes
sense when
the signal handler has been overridden with [Sys.set_signal], but at
some point this module is again responsible for managing the signal
handling for this signal.
*)
val keep_away_from : int -> unit
(** [keep_away_from signo]: This signal [signo] is added to the
"keep away list". This means that this module will never try to
change the signal behavior again for [signo]. Even [restore_management]
will not restore the signal handling again. This function should only
by called by applications wishing to do the signal handling all
themselves.
This function does not have any effect on the already installed
handlers. It is nevertheless useful for applications calling
[Sys.set_signal] directly to ensure that [Netsys_signal] will never
again try to override the handler.
*)
type action =
[ `Callback of int -> unit
| `Install of unit -> unit
]
(** [`Callback] is used for normal handlers, and [`Install] for exclusive
handlers.
*)
type entry =
{ sig_number : int;
sig_library : string option;
sig_priority : int;
sig_keep_default : bool;
sig_name : string;
sig_action : action;
}
val list : unit -> entry list
(** Returns the list of signal handlers *)
val keep_away_list : unit -> int list
(** Returns the "keep away list". *)
val init : unit -> unit
(** Call this function to ensure that this module is initialized. It is
also possible to call any other function. After initialization the
Sigpipe handler is set.
*)
(** {1 Debugging} *)
module Debug : sig
val enable : bool ref
(** Enables {!Netlog}-style debugging of this module *)
end
|