File: semaphore.md

package info (click to toggle)
ocaml-eio 1.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,548 kB
  • sloc: ml: 14,608; ansic: 1,237; makefile: 25
file content (96 lines) | stat: -rw-r--r-- 1,178 bytes parent folder | download
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
# Setting up the environment

```ocaml
# #require "eio.mock";;
```

```ocaml
open Eio.Std

module T = Eio.Semaphore

let run fn =
  Eio_mock.Backend.run @@ fun _ ->
  fn ()

let acquire t =
  traceln "Acquiring";
  T.acquire t;
  traceln "Acquired"

let release t =
  traceln "Releasing";
  T.release t;
  traceln "Released"
```

# Test cases

Simple case:

```ocaml
# run @@ fun () ->
  let t = T.make 1 in
  acquire t;
  release t;
  acquire t;
  release t;;
+Acquiring
+Acquired
+Releasing
+Released
+Acquiring
+Acquired
+Releasing
+Released
- : unit = ()
```

Concurrent access to the semaphore:

```ocaml
# run @@ fun () ->
  let t = T.make 2 in
  let fn () =
    acquire t;
    Eio.Fiber.yield ();
    release t
  in
  List.init 4 (fun _ -> fn)
  |> Fiber.all;;
+Acquiring
+Acquired
+Acquiring
+Acquired
+Acquiring
+Acquiring
+Releasing
+Released
+Releasing
+Released
+Acquired
+Acquired
+Releasing
+Released
+Releasing
+Released
- : unit = ()
```

Cancellation:

```ocaml
# run @@ fun () ->
  let t = T.make 0 in
  Fiber.first
    (fun () -> acquire t)
    (fun () -> ());
  release t;
  acquire t;;
+Acquiring
+Releasing
+Released
+Acquiring
+Acquired
- : unit = ()
```