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
97
98
99
100
|
/*
This file is part of GNUnet.
Copyright (C) 2020--2024 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @author Tobias Frisch
* @file src/messenger/gnunet-service-messenger_list_handles.h
* @brief GNUnet MESSENGER service
*/
#ifndef GNUNET_SERVICE_MESSENGER_LIST_HANDLES_H
#define GNUNET_SERVICE_MESSENGER_LIST_HANDLES_H
#include "gnunet_common.h"
struct GNUNET_MESSENGER_SrvHandle;
struct GNUNET_MESSENGER_ListHandle
{
struct GNUNET_MESSENGER_ListHandle *prev;
struct GNUNET_MESSENGER_ListHandle *next;
struct GNUNET_MESSENGER_SrvHandle *handle;
};
struct GNUNET_MESSENGER_ListHandles
{
struct GNUNET_MESSENGER_ListHandle *head;
struct GNUNET_MESSENGER_ListHandle *tail;
};
/**
* Initializes list of <i>handles</i> as empty list.
*
* @param[out] handles List of handles
*/
void
init_list_handles (struct GNUNET_MESSENGER_ListHandles *handles);
/**
* Destroys remaining <i>handles</i> and clears the list.
*
* @param[in,out] handles List of handles
*/
void
clear_list_handles (struct GNUNET_MESSENGER_ListHandles *handles);
/**
* Adds a specific <i>handle</i> to the end of the list.
*
* @param[in,out] handles List of handles
* @param[in,out] handle Handle
*/
void
add_list_handle (struct GNUNET_MESSENGER_ListHandles *handles,
struct GNUNET_MESSENGER_SrvHandle *handle);
/**
* Removes the first entry matching with a specific <i>handle</i> from the list of
* <i>handles</i> and returns #GNUNET_YES on success or #GNUNET_NO on failure.
*
* @param[in,out] handles List of handles
* @param[in,out] handle Handle
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
enum GNUNET_GenericReturnValue
remove_list_handle (struct GNUNET_MESSENGER_ListHandles *handles,
struct GNUNET_MESSENGER_SrvHandle *handle);
/**
* Searches linearly through the list of <i>handles</i> for members of a specific room
* which is identified by a given <i>key</i>. The handle returned will be one that has
* enabled routing for the room if possible.
*
* If no handle is found which is a current member, NULL gets returned.
*
* @param[in] handles List of handles
* @param[in] key Common key of a room
* @return A handle which is a current member
*/
struct GNUNET_MESSENGER_SrvHandle*
find_list_handle_by_member (const struct GNUNET_MESSENGER_ListHandles *handles,
const struct GNUNET_HashCode *key);
#endif //GNUNET_SERVICE_MESSENGER_LIST_HANDLES_H
|