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_channel.h
23 * @brief mesh service; dealing with end-to-end channels
24 * @author Bartlomiej Polot
26 * All functions in this file should use the prefix GMCH (Gnunet Mesh CHannel)
29 #ifndef GNUNET_SERVICE_MESH_CHANNEL_H
30 #define GNUNET_SERVICE_MESH_CHANNEL_H
35 #if 0 /* keep Emacsens' auto-indent happy */
41 #include "gnunet_util_lib.h"
43 #include "mesh_protocol_enc.h"
47 * Struct containing all information regarding a channel to a remote client.
52 #include "gnunet-service-mesh_tunnel.h"
53 #include "gnunet-service-mesh_local.h"
64 GMCH_get_id (const struct MeshChannel *ch);
67 * Get the channel tunnel.
69 * @param ch Channel to get the tunnel from.
71 * @return tunnel of the channel.
74 GMCH_get_tunnel (const struct MeshChannel *ch);
77 * Get free buffer space towards the client on a specific channel.
80 * @param fwd Is query about FWD traffic?
82 * @return Free buffer space [0 - 64]
85 GMCH_get_buffer (struct MeshChannel *ch, int fwd);
89 * Get flow control status of end point: is client allow to send?
92 * @param fwd Is query about FWD traffic? (Request root status).
94 * @return GNUNET_YES if client is allowed to send us data.
97 GMCH_get_allowed (struct MeshChannel *ch, int fwd);
101 * Is the root client for this channel on this peer?
104 * @param fwd Is this for fwd traffic?
106 * @return GNUNET_YES in case it is.
109 GMCH_is_origin (struct MeshChannel *ch, int fwd);
112 * Is the destination client for this channel on this peer?
115 * @param fwd Is this for fwd traffic?
117 * @return GNUNET_YES in case it is.
120 GMCH_is_terminal (struct MeshChannel *ch, int fwd);
123 * Send data on a channel.
125 * If the destination is local, send it to client, otherwise encrypt and
129 * @param msg Message.
130 * @param fwd Is this a fwd (root->dest) message?
133 GMCH_send_data (struct MeshChannel *ch,
134 const struct GNUNET_MESH_Data *msg,
138 * Send an end-to-end ACK message for the most recent in-sequence payload.
140 * If channel is not reliable, do nothing.
142 * @param ch Channel this is about.
143 * @param fwd Is for FWD traffic? (ACK dest->owner)
146 GMCH_send_data_ack (struct MeshChannel *ch, int fwd);
149 * Notify the destination client that a new incoming channel was created.
151 * @param ch Channel that was created.
154 GMCH_send_create (struct MeshChannel *ch);
157 * Notify a client that the channel is no longer valid.
159 * @param ch Channel that is destroyed.
162 GMCH_send_destroy (struct MeshChannel *ch);
165 * Allow a client to send us more data, in case it was choked.
168 * @param fwd Is this about FWD traffic? (Root client).
171 GMCH_allow_client (struct MeshChannel *ch, int fwd);
179 GMCH_debug (struct MeshChannel *ch);
182 * Handle an ACK given by a client.
184 * Mark client as ready and send him any buffered data we could have for him.
187 * @param fwd Is this a "FWD ACK"? (FWD ACKs are sent by root and go BCK)
190 GMCH_handle_local_ack (struct MeshChannel *ch, int fwd);
193 * Handle data given by a client.
195 * Check whether the client is allowed to send in this tunnel, save if channel
196 * is reliable and send an ACK to the client if there is still buffer space
200 * @param c Client which sent the data.
201 * @param message Message.
202 * @param fwd Is this a FWD data?
204 * @return GNUNET_OK if everything goes well, GNUNET_SYSERR in case of en error.
207 GMCH_handle_local_data (struct MeshChannel *ch,
208 struct MeshClient *c,
209 struct GNUNET_MessageHeader *message,
213 * Handle a channel destroy requested by a client.
215 * Destroy the channel and the tunnel in case this was the last channel.
218 * @param c Client that requested the destruction (to avoid notifying him).
221 GMCH_handle_local_destroy (struct MeshChannel *ch,
222 struct MeshClient *c);
225 * Handle a channel create requested by a client.
227 * Create the channel and the tunnel in case this was the first0 channel.
229 * @param c Client that requested the creation (will be the root).
230 * @param msg Create Channel message.
232 * @return GNUNET_OK if everything went fine, GNUNET_SYSERR otherwise.
235 GMCH_handle_local_create (struct MeshClient *c,
236 struct GNUNET_MESH_ChannelMessage *msg);
239 * Handler for mesh network payload traffic.
241 * @param ch Channel for the message.
242 * @param msg Unencryted data message.
243 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
246 GMCH_handle_data (struct MeshChannel *ch,
247 const struct GNUNET_MESH_Data *msg,
251 * Handler for mesh network traffic end-to-end ACKs.
253 * @param ch Channel on which we got this message.
254 * @param msg Data message.
255 * @param fwd Is this a fwd ACK? (dest->orig)
258 GMCH_handle_data_ack (struct MeshChannel *ch,
259 const struct GNUNET_MESH_DataACK *msg,
263 * Handler for channel create messages.
265 * @param t Tunnel this channel will be in.
266 * @param msg Message.
267 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
270 GMCH_handle_create (struct MeshTunnel3 *t,
271 const struct GNUNET_MESH_ChannelCreate *msg,
275 * Handler for channel ack messages.
277 * @param ch Channel this channel is to be created in.
278 * @param msg Message.
279 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
282 GMCH_handle_ack (struct MeshChannel *ch,
283 const struct GNUNET_MESH_ChannelManage *msg,
287 * Handler for channel destroy messages.
289 * @param ch Channel this channel is to be destroyed of.
290 * @param msg Message.
291 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
294 GMCH_handle_destroy (struct MeshChannel *ch,
295 const struct GNUNET_MESH_ChannelManage *msg,
299 * Sends an already built message on a channel.
301 * If the channel is on a loopback tunnel, notifies the appropriate destination
304 * On a normal channel passes the message to the tunnel for encryption and
305 * sending on a connection.
307 * @param message Message to send. Function makes a copy of it.
308 * @param ch Channel on which this message is transmitted.
309 * @param fwd Is this a fwd message?
312 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
313 struct MeshChannel *ch, int fwd);
316 * Get the static string for identification of the channel.
320 * @return Static string with the channel IDs.
323 GMCH_2s (const struct MeshChannel *ch);
326 #if 0 /* keep Emacsens' auto-indent happy */
333 /* ifndef GNUNET_SERVICE_MESH_CHANNEL_H */
335 /* end of gnunet-service-mesh_channel.h */