diff options
Diffstat (limited to 'src/service/messenger/gnunet-service-messenger_message_recv.h')
-rw-r--r-- | src/service/messenger/gnunet-service-messenger_message_recv.h | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/src/service/messenger/gnunet-service-messenger_message_recv.h b/src/service/messenger/gnunet-service-messenger_message_recv.h new file mode 100644 index 000000000..58eb1d5cc --- /dev/null +++ b/src/service/messenger/gnunet-service-messenger_message_recv.h | |||
@@ -0,0 +1,96 @@ | |||
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_recv.h | ||
23 | * @brief GNUnet MESSENGER service | ||
24 | */ | ||
25 | |||
26 | #ifndef GNUNET_SERVICE_MESSENGER_MESSAGE_RECV_H | ||
27 | #define GNUNET_SERVICE_MESSENGER_MESSAGE_RECV_H | ||
28 | |||
29 | #include "gnunet-service-messenger_tunnel.h" | ||
30 | |||
31 | /** | ||
32 | * Handles a received info message to change the current member id to the one generated by | ||
33 | * the host connected to. (all current tunnels will be informed about the id change) | ||
34 | * | ||
35 | * @param[in,out] room Room of the message | ||
36 | * @param[in,out] tunnel Receiving connection | ||
37 | * @param[in] message INFO-Message | ||
38 | * @param[in] hash Hash of the message | ||
39 | * @return #GNUNET_NO to not forward the message | ||
40 | */ | ||
41 | enum GNUNET_GenericReturnValue | ||
42 | recv_message_info (struct GNUNET_MESSENGER_SrvRoom *room, | ||
43 | struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
44 | const struct GNUNET_MESSENGER_Message *message, | ||
45 | const struct GNUNET_HashCode *hash); | ||
46 | |||
47 | /** | ||
48 | * Handles a received peer message to link it to its origin tunnel if the peer identity matches. | ||
49 | * (the peer message and the member id can potentially be linked to the tunnel) | ||
50 | * | ||
51 | * @param[in,out] room Room of the message | ||
52 | * @param[in,out] tunnel Receiving connection | ||
53 | * @param[in] message PEER-Message | ||
54 | * @param[in] hash Hash of the message | ||
55 | * @return #GNUNET_YES to forward the message | ||
56 | */ | ||
57 | enum GNUNET_GenericReturnValue | ||
58 | recv_message_peer (struct GNUNET_MESSENGER_SrvRoom *room, | ||
59 | struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
60 | const struct GNUNET_MESSENGER_Message *message, | ||
61 | const struct GNUNET_HashCode *hash); | ||
62 | |||
63 | /** | ||
64 | * Handles a received miss message to react to activity in the basement of a room. | ||
65 | * (the miss message can cause automatic opening of the room) | ||
66 | * | ||
67 | * @param[in,out] room Room of the message | ||
68 | * @param[in,out] tunnel Receiving connection | ||
69 | * @param[in] message MISS-Message | ||
70 | * @param[in] hash Hash of the message | ||
71 | * @return #GNUNET_YES to forward the message | ||
72 | */ | ||
73 | enum GNUNET_GenericReturnValue | ||
74 | recv_message_miss (struct GNUNET_MESSENGER_SrvRoom *room, | ||
75 | struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
76 | const struct GNUNET_MESSENGER_Message *message, | ||
77 | const struct GNUNET_HashCode *hash); | ||
78 | |||
79 | /** | ||
80 | * Handles a received request message by checking for the requested message and forwarding it back | ||
81 | * if the message was found. | ||
82 | * (this can also cause this peer to send a new request instead of only forwarding the received one) | ||
83 | * | ||
84 | * @param[in,out] room Room of the message | ||
85 | * @param[in,out] tunnel Receiving connection | ||
86 | * @param[in] message REQUEST-Message | ||
87 | * @param[in] hash Hash of the message | ||
88 | * @return #GNUNET_YES or #GNUNET_NO depending on required forwarding | ||
89 | */ | ||
90 | enum GNUNET_GenericReturnValue | ||
91 | recv_message_request (struct GNUNET_MESSENGER_SrvRoom *room, | ||
92 | struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
93 | const struct GNUNET_MESSENGER_Message *message, | ||
94 | const struct GNUNET_HashCode *hash); | ||
95 | |||
96 | #endif //GNUNET_SERVICE_MESSENGER_MESSAGE_RECV_H | ||