diff options
Diffstat (limited to 'src/messenger/gnunet-service-messenger_list_handles.h')
-rw-r--r-- | src/messenger/gnunet-service-messenger_list_handles.h | 42 |
1 files changed, 22 insertions, 20 deletions
diff --git a/src/messenger/gnunet-service-messenger_list_handles.h b/src/messenger/gnunet-service-messenger_list_handles.h index fe92cc58a..9f7ca725f 100644 --- a/src/messenger/gnunet-service-messenger_list_handles.h +++ b/src/messenger/gnunet-service-messenger_list_handles.h | |||
@@ -1,6 +1,6 @@ | |||
1 | /* | 1 | /* |
2 | This file is part of GNUnet. | 2 | This file is part of GNUnet. |
3 | Copyright (C) 2020 GNUnet e.V. | 3 | Copyright (C) 2020--2021 GNUnet e.V. |
4 | 4 | ||
5 | GNUnet is free software: you can redistribute it and/or modify it | 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 | 6 | under the terms of the GNU Affero General Public License as published |
@@ -30,12 +30,14 @@ | |||
30 | #include "gnunet_crypto_lib.h" | 30 | #include "gnunet_crypto_lib.h" |
31 | #include "gnunet_container_lib.h" | 31 | #include "gnunet_container_lib.h" |
32 | 32 | ||
33 | struct GNUNET_MESSENGER_SrvHandle; | ||
34 | |||
33 | struct GNUNET_MESSENGER_ListHandle | 35 | struct GNUNET_MESSENGER_ListHandle |
34 | { | 36 | { |
35 | struct GNUNET_MESSENGER_ListHandle *prev; | 37 | struct GNUNET_MESSENGER_ListHandle *prev; |
36 | struct GNUNET_MESSENGER_ListHandle *next; | 38 | struct GNUNET_MESSENGER_ListHandle *next; |
37 | 39 | ||
38 | void *handle; | 40 | struct GNUNET_MESSENGER_SrvHandle *handle; |
39 | }; | 41 | }; |
40 | 42 | ||
41 | struct GNUNET_MESSENGER_ListHandles | 43 | struct GNUNET_MESSENGER_ListHandles |
@@ -45,17 +47,17 @@ struct GNUNET_MESSENGER_ListHandles | |||
45 | }; | 47 | }; |
46 | 48 | ||
47 | /** | 49 | /** |
48 | * Initializes list of handles as empty list. | 50 | * Initializes list of <i>handles</i> as empty list. |
49 | * | 51 | * |
50 | * @param handles List of handles | 52 | * @param[out] handles List of handles |
51 | */ | 53 | */ |
52 | void | 54 | void |
53 | init_list_handles (struct GNUNET_MESSENGER_ListHandles *handles); | 55 | init_list_handles (struct GNUNET_MESSENGER_ListHandles *handles); |
54 | 56 | ||
55 | /** | 57 | /** |
56 | * Destroys remaining handles and clears the list. | 58 | * Destroys remaining <i>handles</i> and clears the list. |
57 | * | 59 | * |
58 | * @param handles List of handles | 60 | * @param[in/out] handles List of handles |
59 | */ | 61 | */ |
60 | void | 62 | void |
61 | clear_list_handles (struct GNUNET_MESSENGER_ListHandles *handles); | 63 | clear_list_handles (struct GNUNET_MESSENGER_ListHandles *handles); |
@@ -63,34 +65,34 @@ clear_list_handles (struct GNUNET_MESSENGER_ListHandles *handles); | |||
63 | /** | 65 | /** |
64 | * Adds a specific <i>handle</i> to the end of the list. | 66 | * Adds a specific <i>handle</i> to the end of the list. |
65 | * | 67 | * |
66 | * @param handles List of handles | 68 | * @param[in/out] handles List of handles |
67 | * @param handle Handle | 69 | * @param[in/out] handle Handle |
68 | */ | 70 | */ |
69 | void | 71 | void |
70 | add_list_handle (struct GNUNET_MESSENGER_ListHandles *handles, void *handle); | 72 | add_list_handle (struct GNUNET_MESSENGER_ListHandles *handles, struct GNUNET_MESSENGER_SrvHandle *handle); |
71 | 73 | ||
72 | /** | 74 | /** |
73 | * Removes the first entry matching with a specific <i>handle</i> from the list and | 75 | * Removes the first entry matching with a specific <i>handle</i> from the list of |
74 | * returns GNUNET_YES on success or GNUNET_NO on failure. | 76 | * <i>handles</i> and returns #GNUNET_YES on success or #GNUNET_NO on failure. |
75 | * | 77 | * |
76 | * @param handles List of handles | 78 | * @param[in/out] handles List of handles |
77 | * @param handle Handle | 79 | * @param[in/out] handle Handle |
78 | * @return GNUNET_YES on success, otherwise GNUNET_NO | 80 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO |
79 | */ | 81 | */ |
80 | int | 82 | int |
81 | remove_list_handle (struct GNUNET_MESSENGER_ListHandles *handles, void *handle); | 83 | remove_list_handle (struct GNUNET_MESSENGER_ListHandles *handles, struct GNUNET_MESSENGER_SrvHandle *handle); |
82 | 84 | ||
83 | /** | 85 | /** |
84 | * Searches linearly through the list of handles for members of a specific room | 86 | * Searches linearly through the list of <i>handles</i> for members of a specific room |
85 | * which is identified by a given <i>key</i>. | 87 | * which is identified by a given <i>key</i>. |
86 | * | 88 | * |
87 | * If no handle is found which is a current member, NULL gets returned. | 89 | * If no handle is found which is a current member, NULL gets returned. |
88 | * | 90 | * |
89 | * @param handles List of handles | 91 | * @param[in] handles List of handles |
90 | * @param key Common key of a room | 92 | * @param[in] key Common key of a room |
91 | * @return First handle which is a current member | 93 | * @return First handle which is a current member |
92 | */ | 94 | */ |
93 | void* | 95 | struct GNUNET_MESSENGER_SrvHandle* |
94 | find_list_handle_by_member (struct GNUNET_MESSENGER_ListHandles *handles, const struct GNUNET_HashCode *key); | 96 | find_list_handle_by_member (const struct GNUNET_MESSENGER_ListHandles *handles, const struct GNUNET_HashCode *key); |
95 | 97 | ||
96 | #endif //GNUNET_SERVICE_MESSENGER_LIST_HANDLES_H | 98 | #endif //GNUNET_SERVICE_MESSENGER_LIST_HANDLES_H |