diff options
| author | Emilio Jesus Gallego Arias | 2019-04-04 00:09:10 +0200 |
|---|---|---|
| committer | Emilio Jesus Gallego Arias | 2019-04-04 00:09:10 +0200 |
| commit | 2af2ea43c199177efe64678506e4fe419ea17404 (patch) | |
| tree | 2c6aa80ad8a9c8f2da4c803da89b3e6742d3887f /lib/control.mli | |
| parent | f72de71c43f09554001bbe5808518171a68af335 (diff) | |
| parent | f374b79e08e135de11def93005110a833686c5f7 (diff) | |
Merge PR #9881: Protect some I/O routines from SIGALRM
Ack-by: SkySkimmer
Reviewed-by: ejgallego
Ack-by: maximedenes
Diffstat (limited to 'lib/control.mli')
| -rw-r--r-- | lib/control.mli | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/control.mli b/lib/control.mli index 59e2a15158..640d41a4f7 100644 --- a/lib/control.mli +++ b/lib/control.mli @@ -29,3 +29,14 @@ val timeout : int -> ('a -> 'b) -> 'a -> exn -> 'b API and it is scheduled to go away. *) type timeout = { timeout : 'a 'b. int -> ('a -> 'b) -> 'a -> exn -> 'b } val set_timeout : timeout -> unit + +(** [protect_sigalrm f x] computes [f x], but if SIGALRM is received during that + computation, the signal handler is executed only once the computation is + terminated. Otherwise said, it makes the execution of [f] atomic w.r.t. + handling of SIGALRM. + + This is useful for example to prevent the implementation of `Timeout` to + interrupt I/O routines, generating ill-formed output. + +*) +val protect_sigalrm : ('a -> 'b) -> 'a -> 'b |