aboutsummaryrefslogtreecommitdiff
path: root/src/messenger/gnunet-service-messenger_member.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/messenger/gnunet-service-messenger_member.h')
-rw-r--r--src/messenger/gnunet-service-messenger_member.h180
1 files changed, 0 insertions, 180 deletions
diff --git a/src/messenger/gnunet-service-messenger_member.h b/src/messenger/gnunet-service-messenger_member.h
deleted file mode 100644
index 46269315a..000000000
--- a/src/messenger/gnunet-service-messenger_member.h
+++ /dev/null
@@ -1,180 +0,0 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2020--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 * @author Tobias Frisch
22 * @file src/messenger/gnunet-service-messenger_member.h
23 * @brief GNUnet MESSENGER service
24 */
25
26#ifndef GNUNET_SERVICE_MESSENGER_MEMBER_H
27#define GNUNET_SERVICE_MESSENGER_MEMBER_H
28
29#include "messenger_api_contact.h"
30
31#include "gnunet-service-messenger_list_messages.h"
32#include "gnunet-service-messenger_member_store.h"
33#include "messenger_api_message.h"
34#include "messenger_api_util.h"
35
36struct GNUNET_MESSENGER_Member
37{
38 struct GNUNET_MESSENGER_MemberStore *store;
39 struct GNUNET_ShortHashCode id;
40
41 struct GNUNET_CONTAINER_MultiHashMap *sessions;
42};
43
44/**
45 * Creates and allocates a new member of a <i>room</i> with an optionally defined or
46 * random <i>id</i>.
47 *
48 * If the creation fails, NULL gets returned.
49 *
50 * @param[in/out] store Member store
51 * @param[in] id Member id or NULL
52 * @return New member or NULL
53 */
54struct GNUNET_MESSENGER_Member*
55create_member (struct GNUNET_MESSENGER_MemberStore *store,
56 const struct GNUNET_ShortHashCode *id);
57
58/**
59 * Destroys a member and frees its memory fully.
60 *
61 * @param[in/out] member Member
62 */
63void
64destroy_member (struct GNUNET_MESSENGER_Member *member);
65
66/**
67 * Returns the current id of a given <i>member</i>.
68 *
69 * @param[in] member Member
70 * @return Member id
71 */
72const struct GNUNET_ShortHashCode*
73get_member_id (const struct GNUNET_MESSENGER_Member *member);
74
75/**
76 * Loads data from a <i>directory</i> into a new allocated and created member
77 * of a <i>store</i> if the required information can be read from the content
78 * of the given directory.
79 *
80 * @param[out] store Member store
81 * @param[in] directory Path to a directory
82 */
83void
84load_member (struct GNUNET_MESSENGER_MemberStore *store,
85 const char *directory);
86
87/**
88 * Loads data about next sessions from a <i>directory</i> into an empty loaded
89 * <i>member</i> which does not contain a fully built session graph yet.
90 *
91 * @param[in/out] member Member
92 * @param[in] directory Path to a directory
93 */
94void
95load_member_next_sessions (const struct GNUNET_MESSENGER_Member *member,
96 const char *directory);
97
98/**
99 * Saves data from a <i>member</i> into a directory which
100 * can be load to restore the member completely.
101 *
102 * @param[in] member Member
103 * @param[in] directory Path to a directory
104 */
105void
106save_member (struct GNUNET_MESSENGER_Member *member,
107 const char *directory);
108
109/**
110 * Synchronizes contacts between all sessions from a given <i>member</i>
111 * and other sessions which are linked to them.
112 *
113 * @param[in/out] member Member
114 */
115void
116sync_member_contacts (struct GNUNET_MESSENGER_Member *member);
117
118/**
119 * Returns the member session of a <i>member</i> identified by a given public key.
120 * If the member does not provide a session with the given key, NULL gets returned.
121 *
122 * @param[in] member Member
123 * @param[in] public_key Public key of EGO
124 * @return Member session
125 */
126struct GNUNET_MESSENGER_MemberSession*
127get_member_session (const struct GNUNET_MESSENGER_Member *member,
128 const struct GNUNET_IDENTITY_PublicKey *public_key);
129
130/**
131 * Returns the member session of a <i>member</i> using a public key which can verify
132 * the signature of a given <i>message</i> and its <i>hash</i>. If the member does
133 * not provide a matching session, NULL gets returned.
134 *
135 * @param[in] member Member
136 * @param[in] message Message
137 * @param[in] hash Hash of message
138 * @return Member session
139 */
140struct GNUNET_MESSENGER_MemberSession*
141get_member_session_of (struct GNUNET_MESSENGER_Member *member,
142 const struct GNUNET_MESSENGER_Message *message,
143 const struct GNUNET_HashCode *hash);
144
145/**
146 * Adds a given member <i>session</i> to its <i>member</i>.
147 *
148 * @param[in/out] member Member
149 * @param[in/out] session Member session
150 */
151void
152add_member_session (struct GNUNET_MESSENGER_Member *member,
153 struct GNUNET_MESSENGER_MemberSession *session);
154
155/**
156 * Removes a given member <i>session</i> from its <i>member</i>.
157 *
158 * @param[in/out] member Member
159 * @param[in/out] session Member session
160 */
161void
162remove_member_session (struct GNUNET_MESSENGER_Member *member,
163 struct GNUNET_MESSENGER_MemberSession *session);
164
165/**
166 * Iterate through all member sessions currently connected to a given <i>member</i>
167 * and call the provided iterator callback with a selected closure. The function
168 * will return the amount of member sessions it iterated through.
169 *
170 * @param[in/out] member Member
171 * @param[in] it Iterator callback
172 * @param[in/out] cls Closure
173 * @return Amount of sessions iterated through
174 */
175int
176iterate_member_sessions (struct GNUNET_MESSENGER_Member *member,
177 GNUNET_MESSENGER_MemberIteratorCallback it,
178 void* cls);
179
180#endif //GNUNET_SERVICE_MESSENGER_MEMBER_H