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

(* Remote counters are *global* counters for fresh ids.  In the master/slave
 * scenario, the slave installs a getter that asks the master for a fresh
 * value.  In the scenario of a slave that runs after the death of the master
 * on some marshalled data, a backup of all counters status should be taken and
 * restored to avoid reusing ids.
 * Counters cannot be created by threads, they must be created once and forall
 * as toplevel module declarations. *)


type 'a getter = unit -> 'a
type 'a installer = ('a getter) -> unit

val new_counter : name:string ->
  'a -> incr:('a -> 'a) -> build:('a -> 'b) -> 'b getter * 'b installer

type remote_counters_status
val backup : unit -> remote_counters_status
(* like backup but makes a copy so that further increment does not alter
 * the snapshot *)
val snapshot : unit -> remote_counters_status
val restore : remote_counters_status -> unit