Skip to content

Commit

Permalink
Merge pull request #81 from Vincent-lau/private/shul2/threadext-doc
Browse files Browse the repository at this point in the history
Fix documentation in `threadext.mli`
  • Loading branch information
psafont committed Nov 22, 2023
2 parents 7f89e3f + 2cf1b2f commit 9443c20
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions lib/xapi-stdext-threads/threadext.mli
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,25 @@
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*)
module Mutex :
sig
module Mutex : sig
val execute : Mutex.t -> (unit -> 'a) -> 'a
end

val thread_iter_all_exns: ('a -> unit) -> 'a list -> ('a * exn) list
val thread_iter: ('a -> unit) -> 'a list -> unit
val thread_iter_all_exns : ('a -> unit) -> 'a list -> ('a * exn) list

module Delay :
sig
val thread_iter : ('a -> unit) -> 'a list -> unit

module Delay : sig
type t

val make : unit -> t

val wait : t -> float -> bool
(** Blocks the calling thread for a given period of time with the option of
returning early if someone calls 'signal'. Returns true if the full time
period elapsed and false if signalled. Note that multple 'signals' are
coalesced; 'signals' sent before 'wait' is called are not lost. *)

val wait : t -> float -> bool
(** Sends a signal to a waiting thread. See 'wait' *)

val signal : t -> unit
(** Sends a signal to a waiting thread. See 'wait' *)
end

0 comments on commit 9443c20

Please sign in to comment.