diff options
Diffstat (limited to 'src/messenger/gnunet-service-messenger_tunnel.h')
-rw-r--r-- | src/messenger/gnunet-service-messenger_tunnel.h | 193 |
1 files changed, 0 insertions, 193 deletions
diff --git a/src/messenger/gnunet-service-messenger_tunnel.h b/src/messenger/gnunet-service-messenger_tunnel.h deleted file mode 100644 index 2ffa2d04f..000000000 --- a/src/messenger/gnunet-service-messenger_tunnel.h +++ /dev/null | |||
@@ -1,193 +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_tunnel.h | ||
23 | * @brief GNUnet MESSENGER service | ||
24 | */ | ||
25 | |||
26 | #ifndef GNUNET_SERVICE_MESSENGER_TUNNEL_H | ||
27 | #define GNUNET_SERVICE_MESSENGER_TUNNEL_H | ||
28 | |||
29 | #include "platform.h" | ||
30 | #include "gnunet_cadet_service.h" | ||
31 | #include "gnunet_util_lib.h" | ||
32 | |||
33 | #include "gnunet-service-messenger_room.h" | ||
34 | #include "gnunet-service-messenger_message_state.h" | ||
35 | |||
36 | struct GNUNET_MESSENGER_SrvTunnel | ||
37 | { | ||
38 | struct GNUNET_MESSENGER_SrvRoom *room; | ||
39 | struct GNUNET_CADET_Channel *channel; | ||
40 | |||
41 | GNUNET_PEER_Id peer; | ||
42 | |||
43 | uint32_t messenger_version; | ||
44 | |||
45 | struct GNUNET_HashCode *peer_message; | ||
46 | struct GNUNET_MESSENGER_MessageState state; | ||
47 | }; | ||
48 | |||
49 | /** | ||
50 | * Creates and allocates a tunnel of a <i>room</i> to a specific peer identity (called <i>door</i>). | ||
51 | * | ||
52 | * @param[in,out] room Room | ||
53 | * @param[in] door Peer identity | ||
54 | * @return New tunnel | ||
55 | */ | ||
56 | struct GNUNET_MESSENGER_SrvTunnel* | ||
57 | create_tunnel (struct GNUNET_MESSENGER_SrvRoom *room, | ||
58 | const struct GNUNET_PeerIdentity *door); | ||
59 | |||
60 | /** | ||
61 | * Destroys a <i>tunnel</i> and frees its memory fully. | ||
62 | * | ||
63 | * @param[in,out] tunnel | ||
64 | */ | ||
65 | void | ||
66 | destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
67 | |||
68 | /** | ||
69 | * Binds a CADET <i>channel</i> to a <i>tunnel</i> and replaces its channel | ||
70 | * the tunnel is currently bound to if necessary. | ||
71 | * | ||
72 | * @param[in,out] tunnel Tunnel | ||
73 | * @param[in,out] channel CADET channel | ||
74 | */ | ||
75 | void | ||
76 | bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
77 | struct GNUNET_CADET_Channel *channel); | ||
78 | |||
79 | /** | ||
80 | * Tries to connect a <i>tunnel</i> by creating a new CADET channel and binding it. | ||
81 | * The function returns #GNUNET_YES on success, otherwise #GNUNET_NO. | ||
82 | * | ||
83 | * @param[in,out] tunnel Tunnel | ||
84 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO | ||
85 | */ | ||
86 | int | ||
87 | connect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
88 | |||
89 | /** | ||
90 | * Disconnects and unbinds a channel from a <i>tunnel</i>. The actual disconnection | ||
91 | * will be asynchronous. | ||
92 | * | ||
93 | * @param[in,out] tunnel Tunnel | ||
94 | */ | ||
95 | void | ||
96 | disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
97 | |||
98 | /** | ||
99 | * Returns the status of a currently bound channel of a <i>tunnel</i>. | ||
100 | * | ||
101 | * @param[in] tunnel Tunnel | ||
102 | * @return #GNUNET_YES or #GNUNET_NO | ||
103 | */ | ||
104 | int | ||
105 | is_tunnel_connected (const struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
106 | |||
107 | /** | ||
108 | * Sends an envelope containing a <i>message</i> with a given <i>hash</i> through | ||
109 | * a <i>tunnel</i>. | ||
110 | * | ||
111 | * @param[in,out] tunnel Tunnel | ||
112 | * @param[in,out] env Envelope | ||
113 | * @param[in] hash Hash of message | ||
114 | */ | ||
115 | void | ||
116 | send_tunnel_envelope (struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
117 | struct GNUNET_MQ_Envelope *env, | ||
118 | const struct GNUNET_HashCode *hash); | ||
119 | |||
120 | /** | ||
121 | * Sends a <i>message</i> by packing it automatically into an envelope and passing it | ||
122 | * through the <i>tunnel</i>. The used <i>handle</i> will sign the message and | ||
123 | * the <i>hash</i> will be calculated and stored. | ||
124 | * | ||
125 | * @param[in,out] tunnel Tunnel | ||
126 | * @param[in,out] handle Handle | ||
127 | * @param[in,out] message Message | ||
128 | * @return #GNUNET_YES on success, GNUNET_NO otherwise | ||
129 | */ | ||
130 | int | ||
131 | send_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
132 | void *handle, | ||
133 | struct GNUNET_MESSENGER_Message *message); | ||
134 | |||
135 | /** | ||
136 | * Forwards a given <i>message</i> with a known <i>hash</i> through a <i>tunnel</i>. | ||
137 | * | ||
138 | * @param[in,out] tunnel Tunnel | ||
139 | * @param[in] message Message | ||
140 | * @param[in] hash Hash of message | ||
141 | */ | ||
142 | void | ||
143 | forward_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
144 | const struct GNUNET_MESSENGER_Message *message, | ||
145 | const struct GNUNET_HashCode *hash); | ||
146 | |||
147 | /** | ||
148 | * Returns the hash of the latest peer message published through a given <i>tunnel</i> | ||
149 | * and matching the tunnels peer identity. If no peer message has been linked to the tunnel | ||
150 | * yet, NULL gets returned. | ||
151 | * | ||
152 | * @param[in] tunnel Tunnel | ||
153 | * @return Hash of peer message or NULL | ||
154 | */ | ||
155 | const struct GNUNET_HashCode* | ||
156 | get_tunnel_peer_message (const struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
157 | |||
158 | /** | ||
159 | * Writes the peer identity of the peer connected via <i>tunnel</i> to this peer into | ||
160 | * the <i>peer</i> parameter. | ||
161 | * | ||
162 | * @param[in] tunnel Tunnel | ||
163 | * @param[out] peer Peer identity | ||
164 | */ | ||
165 | void | ||
166 | get_tunnel_peer_identity (const struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
167 | struct GNUNET_PeerIdentity *peer); | ||
168 | |||
169 | /** | ||
170 | * Returns the current messenger version the peer connected via a given <i>tunnel</i> | ||
171 | * has reported to be using if it was compatible during updating. | ||
172 | * | ||
173 | * @see update_tunnel_messenger_version | ||
174 | * | ||
175 | * @param[in] tunnel Tunnel | ||
176 | * @return Version of messenger | ||
177 | */ | ||
178 | uint32_t | ||
179 | get_tunnel_messenger_version (const struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
180 | |||
181 | /** | ||
182 | * Updates the messenger version of the <i>tunnel</i> to a given <i>version</i> if | ||
183 | * it is compatible to the running peer of the service. Depending on success it | ||
184 | * returns #GNUNET_OK or #GNUNET_SYSERR on failure. | ||
185 | * | ||
186 | * @param[in,out] tunnel Tunnel | ||
187 | * @param[in] version Version of messenger | ||
188 | */ | ||
189 | int | ||
190 | update_tunnel_messenger_version (struct GNUNET_MESSENGER_SrvTunnel *tunnel, | ||
191 | uint32_t version); | ||
192 | |||
193 | #endif //GNUNET_SERVICE_MESSENGER_TUNNEL_H | ||