aboutsummaryrefslogtreecommitdiff
path: root/src/service/messenger/gnunet-service-messenger_message_handle.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/service/messenger/gnunet-service-messenger_message_handle.h')
-rw-r--r--src/service/messenger/gnunet-service-messenger_message_handle.h151
1 files changed, 151 insertions, 0 deletions
diff --git a/src/service/messenger/gnunet-service-messenger_message_handle.h b/src/service/messenger/gnunet-service-messenger_message_handle.h
new file mode 100644
index 000000000..a66c45192
--- /dev/null
+++ b/src/service/messenger/gnunet-service-messenger_message_handle.h
@@ -0,0 +1,151 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2020--2024 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_message_handle.h
23 * @brief GNUnet MESSENGER service
24 */
25
26#ifndef GNUNET_SERVICE_MESSENGER_MESSAGE_HANDLE_H
27#define GNUNET_SERVICE_MESSENGER_MESSAGE_HANDLE_H
28
29#include "gnunet-service-messenger_sender_session.h"
30
31/**
32 * Handles a received or sent join message to make changes of current member information.
33 * (add matching member and clear member info)
34 *
35 * @param[in,out] room Room of the message
36 * @param[in,out] session Sender session
37 * @param[in] message JOIN-Message
38 * @param[in] hash Hash of the message
39 */
40void
41handle_message_join (struct GNUNET_MESSENGER_SrvRoom *room,
42 struct GNUNET_MESSENGER_SenderSession *session,
43 const struct GNUNET_MESSENGER_Message *message,
44 const struct GNUNET_HashCode *hash);
45
46/**
47 * Handles a received or sent leave message to make changes of current member information.
48 * (remove matching member and clear member info)
49 *
50 * @param[in,out] room Room of the message
51 * @param[in,out] session Sender session
52 * @param[in] message LEAVE-Message
53 * @param[in] hash Hash of the message
54 */
55void
56handle_message_leave (struct GNUNET_MESSENGER_SrvRoom *room,
57 struct GNUNET_MESSENGER_SenderSession *session,
58 const struct GNUNET_MESSENGER_Message *message,
59 const struct GNUNET_HashCode *hash);
60
61/**
62 * Handles a received or sent key message to change the key of a member and rearrange the contacts accordingly.
63 * (move the member in the contacts and change its key)
64 *
65 * @param[in,out] room Room of the message
66 * @param[in,out] session Sender session
67 * @param[in] message KEY-Message
68 * @param[in] hash Hash of the message
69 */
70void
71handle_message_key (struct GNUNET_MESSENGER_SrvRoom *room,
72 struct GNUNET_MESSENGER_SenderSession *session,
73 const struct GNUNET_MESSENGER_Message *message,
74 const struct GNUNET_HashCode *hash);
75
76/**
77 * Handles a received or sent peer message to make changes of the basement in the room.
78 * (add a new peer to the basement and restructure connections based on updated list of peers)
79 *
80 * @param[in,out] room Room of the message
81 * @param[in,out] session Sender session
82 * @param[in] message PEER-Message
83 * @param[in] hash Hash of the message
84 */
85void
86handle_message_peer (struct GNUNET_MESSENGER_SrvRoom *room,
87 struct GNUNET_MESSENGER_SenderSession *session,
88 const struct GNUNET_MESSENGER_Message *message,
89 const struct GNUNET_HashCode *hash);
90
91/**
92 * Handles a received or sent id message to change a members id.
93 * (change id of matching member)
94 *
95 * @param[in,out] room Room of the message
96 * @param[in,out] session Sender session
97 * @param[in] message ID-Message
98 * @param[in] hash Hash of the message
99 */
100void
101handle_message_id (struct GNUNET_MESSENGER_SrvRoom *room,
102 struct GNUNET_MESSENGER_SenderSession *session,
103 const struct GNUNET_MESSENGER_Message *message,
104 const struct GNUNET_HashCode *hash);
105
106/**
107 * Handles a received or sent miss message to drop a peer from the basement in the room.
108 * (remove a peer from the basement and restructure connections based on updated list of peers)
109 *
110 * @param[in,out] room Room of the message
111 * @param[in,out] session Sender session
112 * @param[in] message MISS-Message
113 * @param[in] hash Hash of the message
114 */
115void
116handle_message_miss (struct GNUNET_MESSENGER_SrvRoom *room,
117 struct GNUNET_MESSENGER_SenderSession *session,
118 const struct GNUNET_MESSENGER_Message *message,
119 const struct GNUNET_HashCode *hash);
120
121/**
122 * Handles a received or sent delete message to delete a specific message from the store.
123 * (remove a message from the store of a room under a given delay)
124 *
125 * @param[in,out] room Room of the message
126 * @param[in,out] session Sender session
127 * @param[in] message DELETE-Message
128 * @param[in] hash Hash of the message
129 */
130void
131handle_message_delete (struct GNUNET_MESSENGER_SrvRoom *room,
132 struct GNUNET_MESSENGER_SenderSession *session,
133 const struct GNUNET_MESSENGER_Message *message,
134 const struct GNUNET_HashCode *hash);
135
136/**
137 * Handles a received or sent connection message to update connection information about a peer.
138 * (update a peer in the basement)
139 *
140 * @param[in,out] room Room of the message
141 * @param[in,out] session Sender session
142 * @param[in] message DELETE-Message
143 * @param[in] hash Hash of the message
144 */
145void
146handle_message_connection (struct GNUNET_MESSENGER_SrvRoom *room,
147 struct GNUNET_MESSENGER_SenderSession *session,
148 const struct GNUNET_MESSENGER_Message *message,
149 const struct GNUNET_HashCode *hash);
150
151#endif //GNUNET_SERVICE_MESSENGER_MESSAGE_HANDLE_H