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 "gnunet-service-mesh_tunnel.h"
  44
  45 /**
  46  * Struct containing all information regarding a channel to a remote client.
  47  */
  48 struct MeshChannel;
  49
  50 /**
  51  * Get channel ID.
  52  *
  53  * @param ch Channel.
  54  *
  55  * @return ID
  56  */
  57 MESH_ChannelNumber
  58 GMCH_get_id (const struct MeshChannel *ch);
  59
  60 /**
  61  * Get free buffer space towards the client on a specific channel.
  62  *
  63  * @param ch Channel.
  64  * @param fwd Is query about FWD traffic?
  65  *
  66  * @return Free buffer space [0 - 64]
  67  */
  68 unsigned int
  69 GMCH_get_buffer (struct MeshChannel *ch, int fwd);
  70
  71 /**
  72  * Send an end-to-end ACK message for the most recent in-sequence payload.
  73  *
  74  * If channel is not reliable, do nothing.
  75  *
  76  * @param ch Channel this is about.
  77  * @param fwd Is for FWD traffic? (ACK dest->owner)
  78  */
  79 void
  80 GMCH_send_ack (struct MeshChannel *ch, int fwd);
  81
  82 /**
  83  * Send data on a channel.
  84  *
  85  * If the destination is local, send it to client, otherwise encrypt and
  86  * send to next hop.
  87  *
  88  * @param ch Channel
  89  * @param msg Message.
  90  * @param fwd Is this a fwd (root->dest) message?
  91  */
  92 void
  93 GMCH_send_data (struct MeshChannel *ch,
  94                 const struct GNUNET_MESH_Data *msg,
  95                 int fwd);
  96
  97 /**
  98  * Notify the destination client that a new incoming channel was created.
  99  *
 100  * @param ch Channel that was created.
 101  */
 102 void
 103 GMCH_send_create (struct MeshChannel *ch);
 104
 105
 106 /**
 107  * Notify a client that the channel is no longer valid.
 108  *
 109  * @param ch Channel that is destroyed.
 110  * @param fwd Forward notification (owner->dest)?
 111  */
 112 void
 113 GMCH_send_destroy (struct MeshChannel *ch, int fwd);
 114
 115
 116 /**
 117  * Log channel info.
 118  *
 119  * @param ch Channel.
 120  */
 121 void
 122 GMCH_debug (struct MeshChannel *ch);
 123
 124
 125 /**
 126  * Handler for mesh network payload traffic.
 127  *
 128  * @param ch Channel for the message.
 129  * @param message Unencryted data message.
 130  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 131  */
 132 void
 133 GMCH_handle_data (struct MeshChannel *ch,
 134                   const struct GNUNET_MESH_Data *msg,
 135                   int fwd);
 136
 137
 138 /**
 139  * Handler for mesh network traffic end-to-end ACKs.
 140  *
 141  * @param t Tunnel on which we got this message.
 142  * @param message Data message.
 143  * @param fwd Is this a fwd ACK? (dest->orig)
 144  */
 145 void
 146 GMCH_handle_data_ack (struct MeshChannel *ch,
 147                       const struct GNUNET_MESH_DataACK *msg,
 148                       int fwd);
 149
 150
 151 /**
 152  * Handler for channel create messages.
 153  *
 154  * @param t Tunnel this channel is to be created in.
 155  * @param msg Message.
 156  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 157  */
 158 struct MeshChannel *
 159 GMCH_handle_create (const struct GNUNET_MESH_ChannelCreate *msg,
 160                     int fwd);
 161
 162
 163 /**
 164  * Handler for channel ack messages.
 165  *
 166  * @param t Tunnel this channel is to be created in.
 167  * @param msg Message.
 168  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 169  */
 170 void
 171 GMCH_handle_ack (struct MeshChannel *ch,
 172                  const struct GNUNET_MESH_ChannelManage *msg,
 173                  int fwd);
 174
 175
 176 /**
 177  * Handler for channel destroy messages.
 178  *
 179  * @param t Tunnel this channel is to be destroyed of.
 180  * @param msg Message.
 181  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
 182  */
 183 void
 184 GMCH_handle_destroy (struct MeshChannel *ch,
 185                      const struct GNUNET_MESH_ChannelManage *msg,
 186                      int fwd);
 187
 188
 189
 190 /**
 191  * Sends an already built message on a channel, properly registering
 192  * all used resources and encrypting the message with the tunnel's key.
 193  *
 194  * @param message Message to send. Function makes a copy of it.
 195  * @param ch Channel on which this message is transmitted.
 196  * @param fwd Is this a fwd message?
 197  */
 198 void
 199 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
 200                             struct MeshChannel *ch, int fwd);
 201
 202
 203 #if 0                           /* keep Emacsens' auto-indent happy */
 204 {
 205 #endif
 206 #ifdef __cplusplus
 207 }
 208 #endif
 209
 210 /* ifndef GNUNET_SERVICE_MESH_CHANNEL_H */
 211 #endif
 212 /* end of gnunet-service-mesh_channel.h */