diff options
author | Christian Grothoff <christian@grothoff.org> | 2020-11-14 17:17:42 +0100 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2020-11-14 17:17:42 +0100 |
commit | c90b5703c88339f7bdf909b77a45ea93c21792cd (patch) | |
tree | fc3397900dc6bdbcdd17cf773f6d60e53abc025a /src/messenger/gnunet-service-messenger_tunnel.h | |
parent | f62e24a88c21235bc3c901508cfb474509ef2961 (diff) | |
parent | d36019fe48ff1e4e56754ef3e689bd67445a38f6 (diff) | |
download | gnunet-c90b5703c88339f7bdf909b77a45ea93c21792cd.tar.gz gnunet-c90b5703c88339f7bdf909b77a45ea93c21792cd.zip |
Merge branch 'master' of git+ssh://gnunet.org/gnunet
Diffstat (limited to 'src/messenger/gnunet-service-messenger_tunnel.h')
-rw-r--r-- | src/messenger/gnunet-service-messenger_tunnel.h | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/src/messenger/gnunet-service-messenger_tunnel.h b/src/messenger/gnunet-service-messenger_tunnel.h new file mode 100644 index 000000000..e6efb226d --- /dev/null +++ b/src/messenger/gnunet-service-messenger_tunnel.h | |||
@@ -0,0 +1,155 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | Copyright (C) 2020 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 | |||
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 | struct GNUNET_ShortHashCode *contact_id; | ||
43 | |||
44 | struct GNUNET_HashCode *peer_message; | ||
45 | struct GNUNET_HashCode *last_message; | ||
46 | }; | ||
47 | |||
48 | /** | ||
49 | * Creates and allocates a tunnel of a <i>room</i> to a specific peer identity. | ||
50 | * | ||
51 | * @param room Room | ||
52 | * @param door Peer identity | ||
53 | * @return New tunnel | ||
54 | */ | ||
55 | struct GNUNET_MESSENGER_SrvTunnel* | ||
56 | create_tunnel (struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_PeerIdentity *door); | ||
57 | |||
58 | /** | ||
59 | * Destroys a <i>tunnel</i> and frees its memory fully. | ||
60 | * | ||
61 | * @param tunnel | ||
62 | */ | ||
63 | void | ||
64 | destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
65 | |||
66 | /** | ||
67 | * Binds a CADET <i>channel</i> to a <i>tunnel</i> on returns GNUNET_YES only if | ||
68 | * the bounds channel was replaced successfully, otherwise GNUNET_NO gets returned. | ||
69 | * | ||
70 | * @param tunnel Tunnel | ||
71 | * @param channel CADET channel | ||
72 | * @return GNUNET_YES on success, otherwise GNUNET_NO | ||
73 | */ | ||
74 | int | ||
75 | bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel, struct GNUNET_CADET_Channel *channel); | ||
76 | |||
77 | /** | ||
78 | * Tries to connect a <i>tunnel</i> by creating a new CADET channel and binding it. | ||
79 | * The function returns GNUNET_YES on success, otherwise GNUNET_NO. | ||
80 | * | ||
81 | * @param tunnel Tunnel | ||
82 | * @return GNUNET_YES on success, otherwise GNUNET_NO | ||
83 | */ | ||
84 | int | ||
85 | connect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
86 | |||
87 | /** | ||
88 | * Disconnects and unbinds a channel from a <i>tunnel</i>. The actual disconnection | ||
89 | * will be asynchronous. | ||
90 | * | ||
91 | * @param tunnel Tunnel | ||
92 | */ | ||
93 | void | ||
94 | disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
95 | |||
96 | /** | ||
97 | * Returns the status of a currently bound channel of a <i>tunnel</i>. | ||
98 | * | ||
99 | * @param tunnel Tunnel | ||
100 | * @return GNUNET_YES or GNUNET_NO | ||
101 | */ | ||
102 | int | ||
103 | is_tunnel_connected (const struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
104 | |||
105 | /** | ||
106 | * Sends an envelope containing a <i>message</i> with a given <i>hash</i> through | ||
107 | * a <i>tunnel</i> by a given <i>handle</i>. | ||
108 | * | ||
109 | * @param tunnel Tunnel | ||
110 | * @param handle Handle | ||
111 | * @param env Envelope | ||
112 | * @param message Message | ||
113 | * @param hash Hash of message | ||
114 | */ | ||
115 | void | ||
116 | send_tunnel_envelope (struct GNUNET_MESSENGER_SrvTunnel *tunnel, void *handle, struct GNUNET_MQ_Envelope *env, | ||
117 | struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash); | ||
118 | |||
119 | /** | ||
120 | * Sends a <i>message</i> by packing it automatically into an envelope and passing it | ||
121 | * through the <i>tunnel</i>. The used <i>handle</i> will sign the message and | ||
122 | * the <i>hash</i> will be calculated and stored. | ||
123 | * | ||
124 | * @param tunnel Tunnel | ||
125 | * @param handle Handle | ||
126 | * @param[out] message Message | ||
127 | * @param[out] hash Hash of message | ||
128 | */ | ||
129 | void | ||
130 | send_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, void *handle, struct GNUNET_MESSENGER_Message *message, | ||
131 | struct GNUNET_HashCode *hash); | ||
132 | |||
133 | /** | ||
134 | * Forwards a given <i>message</i> with a known <i>hash</i> through a <i>tunnel</i>. | ||
135 | * | ||
136 | * @param tunnel Tunnel | ||
137 | * @param message Message | ||
138 | * @param hash Hash of message | ||
139 | */ | ||
140 | void | ||
141 | forward_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, const struct GNUNET_MESSENGER_Message *message, | ||
142 | const struct GNUNET_HashCode *hash); | ||
143 | |||
144 | /** | ||
145 | * Returns the hash of the latest peer message published through a given <i>tunnel</i> | ||
146 | * and matching the tunnels peer identity. If no peer message has been linked to the tunnel | ||
147 | * yet, NULL gets returned. | ||
148 | * | ||
149 | * @param tunnel Tunnel | ||
150 | * @return Hash of peer message or NULL | ||
151 | */ | ||
152 | const struct GNUNET_HashCode* | ||
153 | get_tunnel_peer_message (const struct GNUNET_MESSENGER_SrvTunnel *tunnel); | ||
154 | |||
155 | #endif //GNUNET_SERVICE_MESSENGER_TUNNEL_H | ||