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 id Peer identity.
93 * @param key ECC private key, to derive all other keys and do crypto.
96 GMT_init (const struct GNUNET_CONFIGURATION_Handle *c,
97 const struct GNUNET_PeerIdentity *id,
98 const struct GNUNET_CRYPTO_EddsaPrivateKey *key);
101 * Shut down the tunnel subsystem.
107 * Tunnel is empty: destroy it.
109 * Notifies all connections about the destruction.
111 * @param t Tunnel to destroy.
114 GMT_destroy_empty (struct MeshTunnel3 *t);
117 * Destroy tunnel if empty (no more channels).
119 * @param t Tunnel to destroy if empty.
122 GMT_destroy_if_empty (struct MeshTunnel3 *t);
125 * Destroy the tunnel.
127 * This function does not generate any warning traffic to clients or peers.
130 * Cancel messages belonging to this tunnel queued to neighbors.
131 * Free any allocated resources linked to the tunnel.
133 * @param t The tunnel to destroy.
136 GMT_destroy (struct MeshTunnel3 *t);
139 * Change the tunnel state.
141 * @param t Tunnel whose state to change.
142 * @param state New state.
145 GMT_change_state (struct MeshTunnel3* t, enum MeshTunnel3State state);
148 * Add a connection to a tunnel.
151 * @param c Connection.
154 GMT_add_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
157 * Remove a connection from a tunnel.
160 * @param c Connection.
163 GMT_remove_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
166 * Add a channel to a tunnel.
172 GMT_add_channel (struct MeshTunnel3 *t, struct MeshChannel *ch);
175 * Remove a channel from a tunnel.
181 GMT_remove_channel (struct MeshTunnel3 *t, struct MeshChannel *ch);
184 * Search for a channel by global ID.
186 * @param t Tunnel containing the channel.
187 * @param chid Public channel number.
189 * @return channel handler, NULL if doesn't exist
192 GMT_get_channel (struct MeshTunnel3 *t, MESH_ChannelNumber chid);
196 * Cache a message to be sent once tunnel is online.
198 * @param t Tunnel to hold the message.
199 * @param ch Channel the message is about.
200 * @param msg Message itself (copy will be made).
201 * @param fwd Is this fwd?
204 GMT_queue_data (struct MeshTunnel3 *t,
205 struct MeshChannel *ch,
206 struct GNUNET_MessageHeader *msg,
210 * Send all cached messages that we can, tunnel is online.
212 * @param t Tunnel that holds the messages.
213 * @param fwd Is this fwd?
216 GMT_send_queued_data (struct MeshTunnel3 *t, int fwd);
219 * Count established (ready) connections of a tunnel.
221 * @param t Tunnel on which to count.
223 * @return Number of connections.
226 GMT_count_connections (struct MeshTunnel3 *t);
229 * Count channels of a tunnel.
231 * @param t Tunnel on which to count.
233 * @return Number of channels.
236 GMT_count_channels (struct MeshTunnel3 *t);
239 * Get the state of a tunnel.
243 * @return Tunnel's state.
245 enum MeshTunnel3State
246 GMT_get_state (struct MeshTunnel3 *t);
249 * Get the total buffer space for a tunnel.
252 * @param fwd Is this for FWD traffic?
254 * @return Buffer space offered by all connections in the tunnel.
257 GMT_get_buffer (struct MeshTunnel3 *t, int fwd);
260 * Get the tunnel's destination.
264 * @return ID of the destination peer.
266 const struct GNUNET_PeerIdentity *
267 GMT_get_destination (struct MeshTunnel3 *t);
270 * Get the tunnel's next free Channel ID.
274 * @return ID of a channel free to use.
277 GMT_get_next_chid (struct MeshTunnel3 *t);
280 * Sends an already built message on a tunnel, encrypting it and
281 * choosing the best connection.
283 * @param message Message to send. Function modifies it.
284 * @param t Tunnel on which this message is transmitted.
285 * @param ch Channel on which this message is transmitted.
286 * @param fwd Is this a fwd message?
289 GMT_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
290 struct MeshTunnel3 *t,
291 struct MeshChannel *ch,
295 * Is the tunnel directed towards the local peer?
299 * @return GNUNET_YES if it is loopback.
302 GMT_is_loopback (const struct MeshTunnel3 *t);
305 * Get the static string for the peer this tunnel is directed.
309 * @return Static string the destination peer's ID.
312 GMT_2s (const struct MeshTunnel3 *t);
314 #if 0 /* keep Emacsens' auto-indent happy */
321 /* ifndef GNUNET_MESH_SERVICE_TUNNEL_H */
323 /* end of gnunet-mesh-service_tunnel.h */