diff options
Diffstat (limited to 'src/messenger/testing_messenger_barrier.h')
-rw-r--r-- | src/messenger/testing_messenger_barrier.h | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/src/messenger/testing_messenger_barrier.h b/src/messenger/testing_messenger_barrier.h new file mode 100644 index 000000000..3062a393a --- /dev/null +++ b/src/messenger/testing_messenger_barrier.h | |||
@@ -0,0 +1,131 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | Copyright (C) 2021 GNUnet e.V. | ||
4 | |||
5 | GNUnet is free software: you can redistribute it and/or modify it | ||
6 | under the terms of the GNU Affero General Public License as published | ||
7 | by the Free Software Foundation, either version 3 of the License, | ||
8 | or (at your option) any later version. | ||
9 | |||
10 | GNUnet is distributed in the hope that it will be useful, but | ||
11 | WITHOUT ANY WARRANTY; without even the implied warranty of | ||
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
13 | Affero General Public License for more details. | ||
14 | |||
15 | You should have received a copy of the GNU Affero General Public License | ||
16 | along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
17 | |||
18 | SPDX-License-Identifier: AGPL3.0-or-later | ||
19 | */ | ||
20 | /** | ||
21 | * @file messenger/testing_messenger_barrier.h | ||
22 | * @author Tobias Frisch | ||
23 | * @brief Pseudo-barriers for simple event handling | ||
24 | */ | ||
25 | |||
26 | #ifndef GNUNET_TESTING_MESSENGER_BARRIER_H_ | ||
27 | #define GNUNET_TESTING_MESSENGER_BARRIER_H_ | ||
28 | |||
29 | #include "platform.h" | ||
30 | #include "gnunet_util_lib.h" | ||
31 | |||
32 | /** | ||
33 | * Handle for pseudo-barrier | ||
34 | */ | ||
35 | struct GNUNET_BarrierHandle; | ||
36 | |||
37 | |||
38 | /** | ||
39 | * Functions of this type are to be given as callback argument to | ||
40 | * GNUNET_init_barrier(). The callback will be called when status | ||
41 | * information is available for the pseudo-barrier. | ||
42 | * | ||
43 | * @param cls the closure given to GNUNET_init_barrier() | ||
44 | * @param barrier the pseudo-barrier handle | ||
45 | * @param status status of the pseudo-barrier. The pseudo-barrier is removed | ||
46 | * once it has been crossed or an error occurs while processing it. | ||
47 | * Therefore it is invalid to call GNUNET_cancel_barrier() on a | ||
48 | * crossed or errored pseudo-barrier. | ||
49 | */ | ||
50 | typedef void | ||
51 | (*GNUNET_BarrierStatusCallback) (void *cls, | ||
52 | struct GNUNET_BarrierHandle *barrier, | ||
53 | int status); | ||
54 | |||
55 | |||
56 | /** | ||
57 | * Initialise a pseudo-barrier and call the given callback when the required | ||
58 | * amount of peers (requirement) reach the pseudo-barrier OR upon error. | ||
59 | * | ||
60 | * @param requirement the amount of peers that is required to reach the | ||
61 | * pseudo-barrier. Peers signal reaching a pseudo-barrier by calling | ||
62 | * GNUNET_wait_barrier(). | ||
63 | * @param cb the callback to call when the pseudo-barrier is reached or upon | ||
64 | * error. Can be NULL. | ||
65 | * @param cls closure for the above callback | ||
66 | * @return pseudo-barrier handle; NULL upon error | ||
67 | */ | ||
68 | struct GNUNET_BarrierHandle* | ||
69 | GNUNET_init_barrier (unsigned int requirement, | ||
70 | GNUNET_BarrierStatusCallback cb, | ||
71 | void *cb_cls); | ||
72 | |||
73 | |||
74 | /** | ||
75 | * Cancel a pseudo-barrier. | ||
76 | * | ||
77 | * @param barrier the pseudo-barrier handle | ||
78 | */ | ||
79 | void | ||
80 | GNUNET_cancel_barrier (struct GNUNET_BarrierHandle *barrier); | ||
81 | |||
82 | |||
83 | /** | ||
84 | * Handle for pseudo-barrier wait | ||
85 | */ | ||
86 | struct GNUNET_BarrierWaitHandle; | ||
87 | |||
88 | |||
89 | /** | ||
90 | * Functions of this type are to be given as acallback argument to | ||
91 | * GNUNET_wait_barrier(). The callback will be called when the pseudo-barrier | ||
92 | * corresponding given in GNUNET_wait_barrier() is crossed or cancelled. | ||
93 | * | ||
94 | * @param cls closure pointer given to GNUNET_wait_barrier() | ||
95 | * @param waiting the pseudo-barrier wait handle | ||
96 | * @param status #GNUNET_SYSERR in case of error while waiting for the | ||
97 | * pseudo-barrier; #GNUNET_OK if the pseudo-barrier is crossed | ||
98 | */ | ||
99 | typedef void | ||
100 | (*GNUNET_BarrierWaitStatusCallback) (void *cls, | ||
101 | struct GNUNET_BarrierWaitHandle *waiting, | ||
102 | int status); | ||
103 | |||
104 | |||
105 | /** | ||
106 | * Wait for a pseudo-barrier to be crossed. This function should be called for | ||
107 | * the peers which have been started by the testbed. | ||
108 | * | ||
109 | * @param barrier the pseudo-barrier handle | ||
110 | * @param cb the pseudo-barrier wait callback | ||
111 | * @param cls the closure for the above callback | ||
112 | * @return pseudo-barrier wait handle which can be used to cancel the waiting | ||
113 | * at anytime before the callback is called. NULL upon error. | ||
114 | */ | ||
115 | struct GNUNET_BarrierWaitHandle* | ||
116 | GNUNET_wait_barrier (struct GNUNET_BarrierHandle *barrier, | ||
117 | GNUNET_BarrierWaitStatusCallback cb, | ||
118 | void *cb_cls); | ||
119 | |||
120 | |||
121 | /** | ||
122 | * Cancel a pseudo-barrier wait handle. Should not be called in or after the | ||
123 | * callback given to GNUNET_wait_barrier() has been called. | ||
124 | * | ||
125 | * @param waiting the pseudo-barrier wait handle | ||
126 | */ | ||
127 | void | ||
128 | GNUNET_cancel_wait_barrier (struct GNUNET_BarrierWaitHandle *waiting); | ||
129 | |||
130 | |||
131 | #endif /* GNUNET_TESTING_MESSENGER_BARRIER_H_ */ | ||