2 This file is part of GNUnet.
3 (C) 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file mesh/gnunet-service-mesh_tunnel.h
23 * @brief mesh service; dealing with tunnels and crypto
24 * @author Bartlomiej Polot
26 * All functions in this file should use the prefix GMT (Gnunet Mesh Tunnel)
29 #ifndef GNUNET_SERVICE_MESH_TUNNEL_H
30 #define GNUNET_SERVICE_MESH_TUNNEL_H
35 #if 0 /* keep Emacsens' auto-indent happy */
41 #include "gnunet_util_lib.h"
44 * All the states a tunnel can be in.
49 * Uninitialized status, should never appear in operation.
54 * Path to the peer not known yet
56 MESH_TUNNEL3_SEARCHING,
59 * Request sent, not yet answered.
64 * Peer connected and ready to accept data
69 * Peer connected previosly but not responding
71 MESH_TUNNEL3_RECONNECTING
75 * Struct containing all information regarding a given peer
80 #include "gnunet-service-mesh_channel.h"
81 #include "gnunet-service-mesh_connection.h"
84 /******************************************************************************/
85 /******************************** API ***********************************/
86 /******************************************************************************/
89 * Initialize tunnel subsystem.
91 * @param c Configuration handle.
92 * @param key ECC private key, to derive all other keys and do crypto.
95 GMT_init (const struct GNUNET_CONFIGURATION_Handle *c,
96 const struct GNUNET_CRYPTO_EddsaPrivateKey *key);
99 * Shut down the tunnel subsystem.
105 * Tunnel is empty: destroy it.
107 * Notifies all connections about the destruction.
109 * @param t Tunnel to destroy.
112 GMT_destroy_empty (struct MeshTunnel3 *t);
115 * Destroy tunnel if empty (no more channels).
117 * @param t Tunnel to destroy if empty.
120 GMT_destroy_if_empty (struct MeshTunnel3 *t);
123 * Destroy the tunnel.
125 * This function does not generate any warning traffic to clients or peers.
128 * Cancel messages belonging to this tunnel queued to neighbors.
129 * Free any allocated resources linked to the tunnel.
131 * @param t The tunnel to destroy.
134 GMT_destroy (struct MeshTunnel3 *t);
137 * Change the tunnel state.
139 * @param t Tunnel whose state to change.
140 * @param state New state.
143 GMT_change_state (struct MeshTunnel3* t, enum MeshTunnel3State state);
146 * Add a connection to a tunnel.
149 * @param c Connection.
152 GMT_add_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
155 * Remove a connection from a tunnel.
158 * @param c Connection.
161 GMT_remove_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
164 * Add a channel to a tunnel.
170 GMT_add_channel (struct MeshTunnel3 *t, struct MeshChannel *ch);
173 * Remove a channel from a tunnel.
179 GMT_remove_channel (struct MeshTunnel3 *t, struct MeshChannel *ch);
182 * Search for a channel by global ID.
184 * @param t Tunnel containing the channel.
185 * @param chid Public channel number.
187 * @return channel handler, NULL if doesn't exist
190 GMT_get_channel (struct MeshTunnel3 *t, MESH_ChannelNumber chid);
194 * Cache a message to be sent once tunnel is online.
196 * @param t Tunnel to hold the message.
197 * @param ch Channel the message is about.
198 * @param msg Message itself (copy will be made).
199 * @param fwd Is this fwd?
202 GMT_queue_data (struct MeshTunnel3 *t,
203 struct MeshChannel *ch,
204 struct GNUNET_MessageHeader *msg,
208 * Send all cached messages that we can, tunnel is online.
210 * @param t Tunnel that holds the messages.
211 * @param fwd Is this fwd?
214 GMT_send_queued_data (struct MeshTunnel3 *t, int fwd);
217 * Count established (ready) connections of a tunnel.
219 * @param t Tunnel on which to count.
221 * @return Number of connections.
224 GMT_count_connections (struct MeshTunnel3 *t);
227 * Count channels of a tunnel.
229 * @param t Tunnel on which to count.
231 * @return Number of channels.
234 GMT_count_channels (struct MeshTunnel3 *t);
237 * Get the state of a tunnel.
241 * @return Tunnel's state.
243 enum MeshTunnel3State
244 GMT_get_state (struct MeshTunnel3 *t);
247 * Get the total buffer space for a tunnel.
250 * @param fwd Is this for FWD traffic?
252 * @return Buffer space offered by all connections in the tunnel.
255 GMT_get_buffer (struct MeshTunnel3 *t, int fwd);
258 * Get the tunnel's destination.
262 * @return ID of the destination peer.
264 const struct GNUNET_PeerIdentity *
265 GMT_get_destination (struct MeshTunnel3 *t);
268 * Get the tunnel's next free Channel ID.
272 * @return ID of a channel free to use.
275 GMT_get_next_chid (struct MeshTunnel3 *t);
278 * Sends an already built message on a tunnel, encrypting it and
279 * choosing the best connection.
281 * @param message Message to send. Function modifies it.
282 * @param t Tunnel on which this message is transmitted.
283 * @param ch Channel on which this message is transmitted.
284 * @param fwd Is this a fwd message?
287 GMT_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
288 struct MeshTunnel3 *t,
289 struct MeshChannel *ch,
293 * Is the tunnel directed towards the local peer?
297 * @return GNUNET_YES if it is loopback.
300 GMT_is_loopback (const struct MeshTunnel3 *t);
303 * Get the static string for the peer this tunnel is directed.
307 * @return Static string the destination peer's ID.
310 GMT_2s (const struct MeshTunnel3 *t);
312 #if 0 /* keep Emacsens' auto-indent happy */
319 /* ifndef GNUNET_MESH_SERVICE_TUNNEL_H */
321 /* end of gnunet-mesh-service_tunnel.h */