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