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);
88 * Is the root client for this channel on this peer?
91 * @param fwd Is this for fwd traffic?
93 * @return GNUNET_YES in case it is.
96 GMCH_is_origin (struct MeshChannel *ch, int fwd);
99 * Is the destination client for this channel on this peer?
102 * @param fwd Is this for fwd traffic?
104 * @return GNUNET_YES in case it is.
107 GMCH_is_terminal (struct MeshChannel *ch, int fwd);
110 * Send data on a channel.
112 * If the destination is local, send it to client, otherwise encrypt and
116 * @param msg Message.
117 * @param fwd Is this a fwd (root->dest) message?
120 GMCH_send_data (struct MeshChannel *ch,
121 const struct GNUNET_MESH_Data *msg,
125 * Send an end-to-end ACK message for the most recent in-sequence payload.
127 * If channel is not reliable, do nothing.
129 * @param ch Channel this is about.
130 * @param fwd Is for FWD traffic? (ACK dest->owner)
133 GMCH_send_data_ack (struct MeshChannel *ch, int fwd);
136 * Notify the destination client that a new incoming channel was created.
138 * @param ch Channel that was created.
141 GMCH_send_create (struct MeshChannel *ch);
144 * Notify a client that the channel is no longer valid.
146 * @param ch Channel that is destroyed.
149 GMCH_send_destroy (struct MeshChannel *ch);
157 GMCH_debug (struct MeshChannel *ch);
160 * Handle an ACK given by a client.
162 * Mark client as ready and send him any buffered data we could have for him.
165 * @param fwd Is this a "FWD ACK"? (FWD ACKs are sent by root and go BCK)
168 GMCH_handle_local_ack (struct MeshChannel *ch, int fwd);
171 * Handle data given by a client.
173 * Check whether the client is allowed to send in this tunnel, save if channel
174 * is reliable and send an ACK to the client if there is still buffer space
178 * @param fwd Is this a FWD data?
180 * @return GNUNET_OK if everything goes well, GNUNET_SYSERR in case of en error.
183 GMCH_handle_local_data (struct MeshChannel *ch,
184 struct MeshClient *c,
185 struct GNUNET_MessageHeader *message,
189 * Handle a channel destroy requested by a client.
191 * Destroy the channel and the tunnel in case this was the last channel.
194 * @param c Client that requested the destruction (to avoid notifying him).
197 GMCH_handle_local_destroy (struct MeshChannel *ch,
198 struct MeshClient *c);
201 * Handle a channel create requested by a client.
203 * Create the channel and the tunnel in case this was the first0 channel.
205 * @param c Client that requested the creation (will be the root).
206 * @param msg Create Channel message.
208 * @return GNUNET_OK if everything went fine, GNUNET_SYSERR otherwise.
211 GMCH_handle_local_create (struct MeshClient *c,
212 struct GNUNET_MESH_ChannelMessage *msg);
215 * Handler for mesh network payload traffic.
217 * @param ch Channel for the message.
218 * @param message Unencryted data message.
219 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
222 GMCH_handle_data (struct MeshChannel *ch,
223 const struct GNUNET_MESH_Data *msg,
227 * Handler for mesh network traffic end-to-end ACKs.
229 * @param t Tunnel on which we got this message.
230 * @param message Data message.
231 * @param fwd Is this a fwd ACK? (dest->orig)
234 GMCH_handle_data_ack (struct MeshChannel *ch,
235 const struct GNUNET_MESH_DataACK *msg,
239 * Handler for channel create messages.
241 * @param t Tunnel this channel will be in.
242 * @param msg Message.
243 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
246 GMCH_handle_create (struct MeshTunnel3 *t,
247 const struct GNUNET_MESH_ChannelCreate *msg,
251 * Handler for channel ack messages.
253 * @param t Tunnel this channel is to be created in.
254 * @param msg Message.
255 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
258 GMCH_handle_ack (struct MeshChannel *ch,
259 const struct GNUNET_MESH_ChannelManage *msg,
263 * Handler for channel destroy messages.
265 * @param t Tunnel this channel is to be destroyed of.
266 * @param msg Message.
267 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
270 GMCH_handle_destroy (struct MeshChannel *ch,
271 const struct GNUNET_MESH_ChannelManage *msg,
275 * Sends an already built message on a channel.
277 * If the channel is on a loopback tunnel, notifies the appropriate destination
280 * On a normal channel passes the message to the tunnel for encryption and
281 * sending on a connection.
283 * @param message Message to send. Function makes a copy of it.
284 * @param ch Channel on which this message is transmitted.
285 * @param fwd Is this a fwd message?
288 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
289 struct MeshChannel *ch, int fwd);
292 * Get the static string for identification of the channel.
296 * @return Static string with the channel IDs.
299 GMCH_2s (const struct MeshChannel *ch);
302 #if 0 /* keep Emacsens' auto-indent happy */
309 /* ifndef GNUNET_SERVICE_MESH_CHANNEL_H */
311 /* end of gnunet-service-mesh_channel.h */