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 /**
  44  * Struct containing all information regarding a channel to a remote client.
  45  */
  46 struct MeshChannel;
  47
  48 /**
  49  * Send an end-to-end ACK message for the most recent in-sequence payload.
  50  *
  51  * If channel is not reliable, do nothing.
  52  *
  53  * @param ch Channel this is about.
  54  * @param fwd Is for FWD traffic? (ACK dest->owner)
  55  */
  56 void
  57 GMCH_send_ack (struct MeshChannel *ch, int fwd);
  58
  59 /**
  60  * Send data on a channel.
  61  *
  62  * If the destination is local, send it to client, otherwise encrypt and
  63  * send to next hop.
  64  *
  65  * @param ch Channel
  66  * @param msg Message.
  67  * @param fwd Is this a fwd (root->dest) message?
  68  */
  69 void
  70 GMCH_send_data (struct MeshChannel *ch,
  71                 const struct GNUNET_MESH_Data *msg,
  72                 int fwd);
  73
  74 /**
  75  * Notify the destination client that a new incoming channel was created.
  76  *
  77  * @param ch Channel that was created.
  78  */
  79 void
  80 GMCH_send_create (struct MeshChannel *ch);
  81
  82
  83 /**
  84  * Notify a client that the channel is no longer valid.
  85  *
  86  * @param ch Channel that is destroyed.
  87  * @param fwd Forward notification (owner->dest)?
  88  */
  89 void
  90 GMCH_send_destroy (struct MeshChannel *ch, int fwd);
  91
  92
  93 /**
  94  * Log channel info.
  95  *
  96  * @param ch Channel.
  97  */
  98 void
  99 GMCH_debug (struct MeshChannel *ch);
 100
 101
 102 /**
 103  * Handler for mesh network payload traffic.
 104  *
 105  * @param t Tunnel on which we got this message.
 106  * @param message Unencryted data message.
 107  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 108  */
 109 void
 110 GMCH_handle_data (struct MeshTunnel2 *t,
 111                   const struct GNUNET_MESH_Data *msg,
 112                   int fwd);
 113
 114
 115 /**
 116  * Handler for mesh network traffic end-to-end ACKs.
 117  *
 118  * @param t Tunnel on which we got this message.
 119  * @param message Data message.
 120  * @param fwd Is this a fwd ACK? (dest->orig)
 121  */
 122 void
 123 GMCH_handle_data_ack (struct MeshTunnel2 *t,
 124                       const struct GNUNET_MESH_DataACK *msg,
 125                       int fwd);
 126
 127
 128 /**
 129  * Handler for channel create messages.
 130  *
 131  * @param t Tunnel this channel is to be created in.
 132  * @param msg Message.
 133  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 134  */
 135 void
 136 GMCH_handle_create (struct MeshTunnel2 *t,
 137                     struct GNUNET_MESH_ChannelCreate *msg,
 138                     int fwd);
 139
 140
 141 /**
 142  * Handler for channel ack messages.
 143  *
 144  * @param t Tunnel this channel is to be created in.
 145  * @param msg Message.
 146  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 147  */
 148 void
 149 GMCH_handle_ack (struct MeshTunnel2 *t,
 150                  struct GNUNET_MESH_ChannelManage *msg,
 151                  int fwd);
 152
 153
 154 /**
 155  * Handler for channel destroy messages.
 156  *
 157  * @param t Tunnel this channel is to be destroyed of.
 158  * @param msg Message.
 159  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 160  */
 161 void
 162 GMCH_handle_destroy (struct MeshTunnel2 *t,
 163                      struct GNUNET_MESH_ChannelManage *msg,
 164                      int fwd);
 165
 166
 167
 168
 169 #if 0                           /* keep Emacsens' auto-indent happy */
 170 {
 171 #endif
 172 #ifdef __cplusplus
 173 }
 174 #endif
 175
 176 /* ifndef GNUNET_SERVICE_MESH_CHANNEL_H */
 177 #endif
 178 /* end of gnunet-service-mesh_channel.h */