src/mesh/gnunet-service-mesh_tunnel.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_tunnel.h
  23  * @brief mesh service; dealing with tunnels and crypto
  24  * @author Bartlomiej Polot
  25  *
  26  * All functions in this file should use the prefix GMT (Gnunet Mesh Tunnel)
  27  */
  28
  29 #ifndef GNUNET_SERVICE_MESH_TUNNEL_H
  30 #define GNUNET_SERVICE_MESH_TUNNEL_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 given peer
  45  */
  46 struct MeshTunnel2;
  47
  48
  49 /******************************************************************************/
  50 /********************************    API    ***********************************/
  51 /******************************************************************************/
  52
  53 /**
  54  * Initialize tunnel subsystem.
  55  *
  56  * @param c Configuration handle.
  57  * @param id Peer identity.
  58  * @param key ECC private key, to derive all other keys and do crypto.
  59  */
  60 void
  61 GMT_init (const struct GNUNET_CONFIGURATION_Handle *c,
  62           const struct GNUNET_PeerIdentity *id,
  63           const struct GNUNET_CRYPTO_EccPrivateKey *key);
  64
  65 /**
  66  * Shut down the tunnel subsystem.
  67  */
  68 void
  69 GMT_shutdown (void);
  70
  71 /**
  72  * Change the tunnel state.
  73  *
  74  * @param t Tunnel whose state to change.
  75  * @param state New state.
  76  */
  77 void
  78 GMT_change_state (struct MeshTunnel2* t, enum MeshTunnelState state);
  79
  80
  81 /**
  82  * Cache a message to be sent once tunnel is online.
  83  *
  84  * @param t Tunnel to hold the message.
  85  * @param ch Channel the message is about.
  86  * @param msg Message itself (copy will be made).
  87  * @param fwd Is this fwd?
  88  */
  89 void
  90 GMT_queue_data (struct MeshTunnel2 *t,
  91                 struct MeshChannel *ch,
  92                 struct GNUNET_MessageHeader *msg,
  93                 int fwd);
  94
  95 #if 0                           /* keep Emacsens' auto-indent happy */
  96 {
  97 #endif
  98 #ifdef __cplusplus
  99 }
 100 #endif
 101
 102 /* ifndef GNUNET_MESH_SERVICE_TUNNEL_H */
 103 #endif
 104 /* end of gnunet-mesh-service_tunnel.h */