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"
43 #include "gnunet-service-mesh_channel.h"
44 #include "gnunet-service-mesh_connection.h"
47 * All the states a tunnel can be in.
52 * Uninitialized status, should never appear in operation.
57 * Path to the peer not known yet
59 MESH_TUNNEL_SEARCHING,
62 * Request sent, not yet answered.
67 * Peer connected and ready to accept data
72 * Peer connected previosly but not responding
74 MESH_TUNNEL_RECONNECTING
78 * Struct containing all information regarding a given peer
82 /******************************************************************************/
83 /******************************** API ***********************************/
84 /******************************************************************************/
87 * Initialize tunnel subsystem.
89 * @param c Configuration handle.
90 * @param id Peer identity.
91 * @param key ECC private key, to derive all other keys and do crypto.
94 GMT_init (const struct GNUNET_CONFIGURATION_Handle *c,
95 const struct GNUNET_PeerIdentity *id,
96 const struct GNUNET_CRYPTO_EccPrivateKey *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 MeshTunnelState state);
146 * Add a connection to a tunnel.
149 * @param c Connection.
152 GMT_add_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
156 * Remove a connection from a tunnel.
159 * @param c Connection.
162 GMT_remove_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
165 * Cache a message to be sent once tunnel is online.
167 * @param t Tunnel to hold the message.
168 * @param ch Channel the message is about.
169 * @param msg Message itself (copy will be made).
170 * @param fwd Is this fwd?
173 GMT_queue_data (struct MeshTunnel3 *t,
174 struct MeshChannel *ch,
175 struct GNUNET_MessageHeader *msg,
179 * Send all cached messages that we can, tunnel is online.
181 * @param t Tunnel that holds the messages.
182 * @param fwd Is this fwd?
185 GMT_send_queued_data (struct MeshTunnel3 *t, int fwd);
188 * Count established (ready) connections of a tunnel.
190 * @param t Tunnel on which to count.
192 * @return Number of connections.
195 GMT_count_connections (struct MeshTunnel3 *t);
198 * Count channels of a tunnel.
200 * @param t Tunnel on which to count.
202 * @return Number of channels.
205 GMT_count_channels (struct MeshTunnel3 *t);
208 * Get the state of a tunnel.
212 * @return Tunnel's state.
215 GMT_get_state (struct MeshTunnel3 *t);
218 * Get the total buffer space for a tunnel.
221 * @param fwd Is this for FWD traffic?
223 * @return Buffer space offered by all connections in the tunnel.
226 GMT_get_buffer (struct MeshTunnel3 *t, int fwd);
228 #if 0 /* keep Emacsens' auto-indent happy */
235 /* ifndef GNUNET_MESH_SERVICE_TUNNEL_H */
237 /* end of gnunet-mesh-service_tunnel.h */