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.h186
1 files changed, 0 insertions, 186 deletions
diff --git a/src/messenger/gnunet-service-messenger_tunnel.h b/src/messenger/gnunet-service-messenger_tunnel.h
deleted file mode 100644
index 96d98546d..000000000
--- a/src/messenger/gnunet-service-messenger_tunnel.h
+++ /dev/null
@@ -1,186 +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, 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 */
65void
66destroy_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 */
75void
76bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel, struct GNUNET_CADET_Channel *channel);
77
78/**
79 * Tries to connect a <i>tunnel</i> by creating a new CADET channel and binding it.
80 * The function returns #GNUNET_YES on success, otherwise #GNUNET_NO.
81 *
82 * @param[in/out] tunnel Tunnel
83 * @return #GNUNET_YES on success, otherwise #GNUNET_NO
84 */
85int
86connect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
87
88/**
89 * Disconnects and unbinds a channel from a <i>tunnel</i>. The actual disconnection
90 * will be asynchronous.
91 *
92 * @param[in/out] tunnel Tunnel
93 */
94void
95disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
96
97/**
98 * Returns the status of a currently bound channel of a <i>tunnel</i>.
99 *
100 * @param[in] tunnel Tunnel
101 * @return #GNUNET_YES or #GNUNET_NO
102 */
103int
104is_tunnel_connected (const struct GNUNET_MESSENGER_SrvTunnel *tunnel);
105
106/**
107 * Sends an envelope containing a <i>message</i> with a given <i>hash</i> through
108 * a <i>tunnel</i>.
109 *
110 * @param[in/out] tunnel Tunnel
111 * @param[in/out] env Envelope
112 * @param[in] hash Hash of message
113 */
114void
115send_tunnel_envelope (struct GNUNET_MESSENGER_SrvTunnel *tunnel, struct GNUNET_MQ_Envelope *env,
116 const struct GNUNET_HashCode *hash);
117
118/**
119 * Sends a <i>message</i> by packing it automatically into an envelope and passing it
120 * through the <i>tunnel</i>. The used <i>handle</i> will sign the message and
121 * the <i>hash</i> will be calculated and stored.
122 *
123 * @param[in/out] tunnel Tunnel
124 * @param[in/out] handle Handle
125 * @param[in/out] message Message
126 * @return #GNUNET_YES on success, GNUNET_NO otherwise
127 */
128int
129send_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, void *handle, struct GNUNET_MESSENGER_Message *message);
130
131/**
132 * Forwards a given <i>message</i> with a known <i>hash</i> through a <i>tunnel</i>.
133 *
134 * @param[in/out] tunnel Tunnel
135 * @param[in] message Message
136 * @param[in] hash Hash of message
137 */
138void
139forward_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, const struct GNUNET_MESSENGER_Message *message,
140 const struct GNUNET_HashCode *hash);
141
142/**
143 * Returns the hash of the latest peer message published through a given <i>tunnel</i>
144 * and matching the tunnels peer identity. If no peer message has been linked to the tunnel
145 * yet, NULL gets returned.
146 *
147 * @param[in] tunnel Tunnel
148 * @return Hash of peer message or NULL
149 */
150const struct GNUNET_HashCode*
151get_tunnel_peer_message (const struct GNUNET_MESSENGER_SrvTunnel *tunnel);
152
153/**
154 * Writes the peer identity of the peer connected via <i>tunnel</i> to this peer into
155 * the <i>peer</i> parameter.
156 *
157 * @param[in] tunnel Tunnel
158 * @param[out] peer Peer identity
159 */
160void
161get_tunnel_peer_identity (const struct GNUNET_MESSENGER_SrvTunnel *tunnel, struct GNUNET_PeerIdentity *peer);
162
163/**
164 * Returns the current messenger version the peer connected via a given <i>tunnel</i>
165 * has reported to be using if it was compatible during updating.
166 *
167 * @see update_tunnel_messenger_version
168 *
169 * @param[in] tunnel Tunnel
170 * @return Version of messenger
171 */
172uint32_t
173get_tunnel_messenger_version (const struct GNUNET_MESSENGER_SrvTunnel *tunnel);
174
175/**
176 * Updates the messenger version of the <i>tunnel</i> to a given <i>version</i> if
177 * it is compatible to the running peer of the service. Depending on success it
178 * returns #GNUNET_OK or #GNUNET_SYSERR on failure.
179 *
180 * @param[in/out] tunnel Tunnel
181 * @param[in] version Version of messenger
182 */
183int
184update_tunnel_messenger_version (struct GNUNET_MESSENGER_SrvTunnel *tunnel, uint32_t version);
185
186#endif //GNUNET_SERVICE_MESSENGER_TUNNEL_H