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 "gnunet-service-mesh_tunnel.h"
46 * Struct containing all information regarding a channel to a remote client.
58 GMCH_get_id (const struct MeshChannel *ch);
61 * Get the channel tunnel.
63 * @param ch Channel to get the tunnel from.
65 * @return tunnel of the channel.
68 GMCH_get_tunnel (const struct MeshChannel *ch);
71 * Get free buffer space towards the client on a specific channel.
74 * @param fwd Is query about FWD traffic?
76 * @return Free buffer space [0 - 64]
79 GMCH_get_buffer (struct MeshChannel *ch, int fwd);
82 * Is the root client for this channel on this peer?
85 * @param fwd Is this for fwd traffic?
87 * @return GNUNET_YES in case it is.
90 GMCH_is_origin (struct MeshChannel *ch, int fwd);
93 * Is the destination client for this channel on this peer?
96 * @param fwd Is this for fwd traffic?
98 * @return GNUNET_YES in case it is.
101 GMCH_is_terminal (struct MeshChannel *ch, int fwd);
104 * Send an end-to-end ACK message for the most recent in-sequence payload.
106 * If channel is not reliable, do nothing.
108 * @param ch Channel this is about.
109 * @param fwd Is for FWD traffic? (ACK dest->owner)
112 GMCH_send_ack (struct MeshChannel *ch, int fwd);
115 * Send data on a channel.
117 * If the destination is local, send it to client, otherwise encrypt and
121 * @param msg Message.
122 * @param fwd Is this a fwd (root->dest) message?
125 GMCH_send_data (struct MeshChannel *ch,
126 const struct GNUNET_MESH_Data *msg,
130 * Notify the destination client that a new incoming channel was created.
132 * @param ch Channel that was created.
135 GMCH_send_create (struct MeshChannel *ch);
139 * Notify a client that the channel is no longer valid.
141 * @param ch Channel that is destroyed.
142 * @param fwd Forward notification (owner->dest)?
145 GMCH_send_destroy (struct MeshChannel *ch, int fwd);
154 GMCH_debug (struct MeshChannel *ch);
158 * Handler for mesh network payload traffic.
160 * @param ch Channel for the message.
161 * @param message Unencryted data message.
162 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
165 GMCH_handle_data (struct MeshChannel *ch,
166 const struct GNUNET_MESH_Data *msg,
171 * Handler for mesh network traffic end-to-end ACKs.
173 * @param t Tunnel on which we got this message.
174 * @param message Data message.
175 * @param fwd Is this a fwd ACK? (dest->orig)
178 GMCH_handle_data_ack (struct MeshChannel *ch,
179 const struct GNUNET_MESH_DataACK *msg,
184 * Handler for channel create messages.
186 * @param t Tunnel this channel is to be created in.
187 * @param msg Message.
188 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
191 GMCH_handle_create (const struct GNUNET_MESH_ChannelCreate *msg,
196 * Handler for channel ack messages.
198 * @param t Tunnel this channel is to be created in.
199 * @param msg Message.
200 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
203 GMCH_handle_ack (struct MeshChannel *ch,
204 const struct GNUNET_MESH_ChannelManage *msg,
209 * Handler for channel destroy messages.
211 * @param t Tunnel this channel is to be destroyed of.
212 * @param msg Message.
213 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
216 GMCH_handle_destroy (struct MeshChannel *ch,
217 const struct GNUNET_MESH_ChannelManage *msg,
223 * Sends an already built message on a channel, properly registering
224 * all used resources and encrypting the message with the tunnel's key.
226 * @param message Message to send. Function makes a copy of it.
227 * @param ch Channel on which this message is transmitted.
228 * @param fwd Is this a fwd message?
231 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
232 struct MeshChannel *ch, int fwd);
235 #if 0 /* keep Emacsens' auto-indent happy */
242 /* ifndef GNUNET_SERVICE_MESH_CHANNEL_H */
244 /* end of gnunet-service-mesh_channel.h */