aboutsummaryrefslogtreecommitdiffhomepage
path: root/stm/tQueue.mli
blob: f005b58ad1bc67c7e1eb23890fb97dd0ab920f27 (plain)
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
(************************************************************************)
(*  v      *   The Coq Proof Assistant  /  The Coq Development Team     *)
(* <O___,, *   INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2017     *)
(*   \VV/  **************************************************************)
(*    //   *      This file is distributed under the terms of the       *)
(*         *       GNU Lesser General Public License Version 2.1        *)
(************************************************************************)

(* Thread safe queue with some extras *)

type 'a t
val create : unit -> 'a t
val pop : ?picky:('a -> bool) -> ?destroy:bool ref -> 'a t -> 'a
val push : 'a t -> 'a -> unit
val set_order : 'a t -> ('a -> 'a -> int) -> unit
val wait_until_n_are_waiting_and_queue_empty : int -> 'a t -> unit

(* Wake up all waiting threads *)
val broadcast : 'a t -> unit

(* Non destructive *)
val wait_until_n_are_waiting_then_snapshot : int -> 'a t -> 'a list

val clear : 'a t -> unit
val clear_saving : 'a t -> ('a -> 'b option) -> 'b list
val is_empty : 'a t -> bool

exception BeingDestroyed
(* Threads blocked in pop can get this exception if the queue is being
 * destroyed *)
val destroy : 'a t -> unit

val length : 'a t -> int