src/mesh/gnunet-service-mesh_channel.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2013 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file mesh/gnunet-service-mesh_channel.h
  23  * @brief mesh service; dealing with end-to-end channels
  24  * @author Bartlomiej Polot
  25  *
  26  * All functions in this file should use the prefix GMCH (Gnunet Mesh CHannel)
  27  */
  28
  29 #ifndef GNUNET_SERVICE_MESH_CHANNEL_H
  30 #define GNUNET_SERVICE_MESH_CHANNEL_H
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 #include "platform.h"
  41 #include "gnunet_util_lib.h"
  42
  43 #include "mesh_protocol_enc.h"
  44
  45 /**
  46  * Struct containing all information regarding a channel to a remote client.
  47  */
  48 struct MeshChannel;
  49
  50
  51 #include "gnunet-service-mesh_tunnel.h"
  52
  53
  54 /**
  55  * Get channel ID.
  56  *
  57  * @param ch Channel.
  58  *
  59  * @return ID
  60  */
  61 MESH_ChannelNumber
  62 GMCH_get_id (const struct MeshChannel *ch);
  63
  64 /**
  65  * Get the channel tunnel.
  66  *
  67  * @param ch Channel to get the tunnel from.
  68  *
  69  * @return tunnel of the channel.
  70  */
  71 struct MeshTunnel3 *
  72 GMCH_get_tunnel (const struct MeshChannel *ch);
  73
  74 /**
  75  * Get free buffer space towards the client on a specific channel.
  76  *
  77  * @param ch Channel.
  78  * @param fwd Is query about FWD traffic?
  79  *
  80  * @return Free buffer space [0 - 64]
  81  */
  82 unsigned int
  83 GMCH_get_buffer (struct MeshChannel *ch, int fwd);
  84
  85 /**
  86  * Is the root client for this channel on this peer?
  87  *
  88  * @param ch Channel.
  89  * @param fwd Is this for fwd traffic?
  90  *
  91  * @return GNUNET_YES in case it is.
  92  */
  93 int
  94 GMCH_is_origin (struct MeshChannel *ch, int fwd);
  95
  96 /**
  97  * Is the destination client for this channel on this peer?
  98  *
  99  * @param ch Channel.
 100  * @param fwd Is this for fwd traffic?
 101  *
 102  * @return GNUNET_YES in case it is.
 103  */
 104 int
 105 GMCH_is_terminal (struct MeshChannel *ch, int fwd);
 106
 107 /**
 108  * Send an end-to-end ACK message for the most recent in-sequence payload.
 109  *
 110  * If channel is not reliable, do nothing.
 111  *
 112  * @param ch Channel this is about.
 113  * @param fwd Is for FWD traffic? (ACK dest->owner)
 114  */
 115 void
 116 GMCH_send_ack (struct MeshChannel *ch, int fwd);
 117
 118 /**
 119  * Send data on a channel.
 120  *
 121  * If the destination is local, send it to client, otherwise encrypt and
 122  * send to next hop.
 123  *
 124  * @param ch Channel
 125  * @param msg Message.
 126  * @param fwd Is this a fwd (root->dest) message?
 127  */
 128 void
 129 GMCH_send_data (struct MeshChannel *ch,
 130                 const struct GNUNET_MESH_Data *msg,
 131                 int fwd);
 132
 133 /**
 134  * Notify the destination client that a new incoming channel was created.
 135  *
 136  * @param ch Channel that was created.
 137  */
 138 void
 139 GMCH_send_create (struct MeshChannel *ch);
 140
 141
 142 /**
 143  * Notify a client that the channel is no longer valid.
 144  *
 145  * @param ch Channel that is destroyed.
 146  */
 147 void
 148 GMCH_send_destroy (struct MeshChannel *ch);
 149
 150
 151 /**
 152  * Log channel info.
 153  *
 154  * @param ch Channel.
 155  */
 156 void
 157 GMCH_debug (struct MeshChannel *ch);
 158
 159
 160 /**
 161  * Handler for mesh network payload traffic.
 162  *
 163  * @param ch Channel for the message.
 164  * @param message Unencryted data message.
 165  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 166  */
 167 void
 168 GMCH_handle_data (struct MeshChannel *ch,
 169                   const struct GNUNET_MESH_Data *msg,
 170                   int fwd);
 171
 172
 173 /**
 174  * Handler for mesh network traffic end-to-end ACKs.
 175  *
 176  * @param t Tunnel on which we got this message.
 177  * @param message Data message.
 178  * @param fwd Is this a fwd ACK? (dest->orig)
 179  */
 180 void
 181 GMCH_handle_data_ack (struct MeshChannel *ch,
 182                       const struct GNUNET_MESH_DataACK *msg,
 183                       int fwd);
 184
 185
 186 /**
 187  * Handler for channel create messages.
 188  *
 189  * @param t Tunnel this channel is to be created in.
 190  * @param msg Message.
 191  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 192  */
 193 struct MeshChannel *
 194 GMCH_handle_create (const struct GNUNET_MESH_ChannelCreate *msg,
 195                     int fwd);
 196
 197
 198 /**
 199  * Handler for channel ack messages.
 200  *
 201  * @param t Tunnel this channel is to be created in.
 202  * @param msg Message.
 203  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 204  */
 205 void
 206 GMCH_handle_ack (struct MeshChannel *ch,
 207                  const struct GNUNET_MESH_ChannelManage *msg,
 208                  int fwd);
 209
 210
 211 /**
 212  * Handler for channel destroy messages.
 213  *
 214  * @param t Tunnel this channel is to be destroyed of.
 215  * @param msg Message.
 216  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 217  */
 218 void
 219 GMCH_handle_destroy (struct MeshChannel *ch,
 220                      const struct GNUNET_MESH_ChannelManage *msg,
 221                      int fwd);
 222
 223
 224
 225 /**
 226  * Sends an already built message on a channel, properly registering
 227  * all used resources and encrypting the message with the tunnel's key.
 228  *
 229  * @param message Message to send. Function makes a copy of it.
 230  * @param ch Channel on which this message is transmitted.
 231  * @param fwd Is this a fwd message?
 232  */
 233 void
 234 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
 235                             struct MeshChannel *ch, int fwd);
 236
 237
 238 #if 0                           /* keep Emacsens' auto-indent happy */
 239 {
 240 #endif
 241 #ifdef __cplusplus
 242 }
 243 #endif
 244
 245 /* ifndef GNUNET_SERVICE_MESH_CHANNEL_H */
 246 #endif
 247 /* end of gnunet-service-mesh_channel.h */