Skip to content

Commit 290795a

Browse files
committed
Add documentation
1 parent d133870 commit 290795a

File tree

3 files changed

+39
-35
lines changed

3 files changed

+39
-35
lines changed

examples/xtd.core.examples/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,7 @@
274274
## [Threading](threading/README.md)
275275

276276
* [auto_reset_event](threading/auto_reset_event/README.md) shows how to use [xtd::threading::auto_reset_event](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1auto_reset_event.html) class.
277+
* [event_wait_handle](threading/event_wait_handle/README.md) shows how to use [xtd::threading::event_wait_handle](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1event__wait__handle.html) class.
277278
* [interlocked](threading/interlocked/README.md) shows hows how to use [xtd::threading::interlocked](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1interlocked.html) class.
278279
* [interlocked_decrement](threading/interlocked_decrement/README.md) shows hows how to use [xtd::threading::interlocked::decrement](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1interlocked.html#a4f4545f0c5952db7df8ff6fc4aa41067) and [xtd::threading::interlocked::increment](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1interlocked.html#acf60d0d23279ede3b23ddee39265aadd) methods.
279280
* [mixing_std_and_xtd_threads](threading/mixing_std_and_xtd_threads/README.md) shows how to use and mixing [xtd::threading::thread](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1thread.html) and [std::thread](https://en.cppreference.com/w/cpp/thread/thread) classes.

examples/xtd.core.examples/threading/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
[This folder](.) contains network examples used by [Reference Guide](https://gammasoft71.github.io/xtd/reference_guides/latest/) and more.
44

55
* [auto_reset_event](auto_reset_event/README.md) shows how to use [xtd::threading::auto_reset_event](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1auto_reset_event.html) class.
6+
* [event_wait_handle](event_wait_handle/README.md) shows how to use [xtd::threading::event_wait_handle](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1event__wait__handle.html) class.
67
* [interlocked](interlocked/README.md) shows hows how to use [xtd::network::interlocked](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1interlocked.html) class.
78
* [interlocked_decrement](interlocked_decrement/README.md) shows hows how to use [xtd::threading::interlocked::decrement](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1interlocked.html#a4f4545f0c5952db7df8ff6fc4aa41067) and [xtd::threading::interlocked::increment](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1interlocked.html#acf60d0d23279ede3b23ddee39265aadd) methods.
89
* [mixing_std_and_xtd_threads](mixing_std_and_xtd_threads/README.md) shows how to use and mixing [xtd::threading::thread](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1thread.html) and [std::thread](https://en.cppreference.com/w/cpp/thread/thread) classes.
910
* [thread](thread/README.md) shows hows how to use [xtd::threading::thread](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1thread.html) class.
11+
Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# auto_reset_event
1+
# event_wait_handle
22

3-
Shows how to use [xtd::threading::auto_reset_event](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1auto_reset_event.html) class.
3+
Shows how to use [xtd::threading::event_wait_handle](https://gammasoft71.github.io/xtd/reference_guides/latest/classxtd_1_1threading_1_1event__wait__handle.html) class.
44

55
## Sources
66

7-
[src/auto_reset_event.cpp](src/auto_reset_event.cpp)
7+
[src/event_wait_handle.cpp](src/event_wait_handle.cpp)
88

99
[CMakeLists.txt](CMakeLists.txt)
1010

@@ -19,36 +19,37 @@ xtdc run
1919
# Output
2020

2121
```
22-
Press Enter to create three threads and start them.
23-
The threads wait on auto_reset_event #1, which was created
24-
in the signaled state, so the first thread is released.
25-
This puts auto_reset_event #1 into the unsignaled state.
26-
27-
thread_0x16fe87000 waits on auto_reset_event #1.
28-
thread_0x16fe87000 is released from auto_reset_event #1.
29-
thread_0x16fe87000 waits on auto_reset_event #2.
30-
thread_0x16ff13000 waits on auto_reset_event #1.
31-
thread_0x16ff9f000 waits on auto_reset_event #1.
32-
Press Enter to release another thread.
33-
34-
thread_0x16ff9f000 is released from auto_reset_event #1.
35-
thread_0x16ff9f000 waits on auto_reset_event #2.
36-
Press Enter to release another thread.
37-
38-
thread_0x16ff13000 is released from auto_reset_event #1.
39-
thread_0x16ff13000 waits on auto_reset_event #2.
40-
41-
All threads are now waiting on auto_reset_event #2.
42-
Press Enter to release a thread.
43-
44-
thread_0x16ff9f000 is released from auto_reset_event #2.
45-
thread_0x16ff9f000 ends.
46-
Press Enter to release a thread.
47-
48-
thread_0x16fe87000 is released from auto_reset_event #2.
49-
thread_0x16fe87000 ends.
50-
Press Enter to release a thread.
51-
52-
thread_0x16ff13000 is released from auto_reset_event #2.
53-
thread_0x16ff13000 ends.
22+
Thread 2 blocks.
23+
Thread 4 blocks.
24+
Thread 0 blocks.
25+
Thread 1 blocks.
26+
Thread 3 blocks.
27+
Press ENTER to release a waiting thread.
28+
29+
Thread 4 exits.
30+
Press ENTER to release a waiting thread.
31+
32+
Thread 2 exits.
33+
Press ENTER to release a waiting thread.
34+
35+
Thread 0 exits.
36+
Press ENTER to release a waiting thread.
37+
38+
Thread 1 exits.
39+
Press ENTER to release a waiting thread.
40+
41+
Thread 3 exits.
42+
43+
Thread 0 blocks.
44+
Thread 1 blocks.
45+
Thread 3 blocks.
46+
Thread 2 blocks.
47+
Thread 4 blocks.
48+
Press ENTER to release the waiting threads.
49+
50+
Thread 2 exits.
51+
Thread 1 exits.
52+
Thread 4 exits.
53+
Thread 3 exits.
54+
Thread 0 exits.
5455
```

0 commit comments

Comments
 (0)