src/transport/gnunet-service-transport.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010,2011 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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file transport/gnunet-service-transport.h
  23  * @brief globals
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_TRANSPORT_H
  27 #define GNUNET_SERVICE_TRANSPORT_H
  28
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_statistics_service.h"
  31 #include "gnunet_ats_service.h"
  32 #include "gnunet_transport_service.h"
  33
  34 #define VERBOSE_VALIDATION GNUNET_YES
  35
  36 /**
  37  * Statistics handle.
  38  */
  39 extern struct GNUNET_STATISTICS_Handle *GST_stats;
  40
  41 /**
  42  * Configuration handle.
  43  */
  44 extern const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
  45
  46 /**
  47  * Configuration handle.
  48  */
  49 extern struct GNUNET_PeerIdentity GST_my_identity;
  50
  51 /**
  52  * Handle to peerinfo service.
  53  */
  54 extern struct GNUNET_PEERINFO_Handle *GST_peerinfo;
  55
  56 /**
  57  * Our private key.
  58  */
  59 extern struct GNUNET_CRYPTO_EddsaPrivateKey *GST_my_private_key;
  60
  61 /**
  62  * ATS handle.
  63  */
  64 extern struct GNUNET_ATS_SchedulingHandle *GST_ats;
  65
  66 /**
  67  * ATS connectivity handle.
  68  */
  69 extern struct GNUNET_ATS_ConnectivityHandle *GST_ats_connect;
  70
  71 /**
  72  * Interface scanner determines our LAN address range(s).
  73  */
  74 extern struct GNUNET_ATS_InterfaceScanner *GST_is;
  75
  76
  77 /**
  78  * Function to call when a peer's address has changed
  79  *
  80  * @param cls closure
  81  * @param peer peer this update is about,
  82  * @param address address, NULL for disconnect notification
  83  */
  84 typedef void
  85 (*GNUNET_TRANSPORT_NeighbourChangeCallback) (void *cls,
  86     const struct GNUNET_PeerIdentity *peer,
  87     const struct GNUNET_HELLO_Address *address,
  88     enum GNUNET_TRANSPORT_PeerState state,
  89     struct GNUNET_TIME_Absolute state_timeout,
  90     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
  91     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
  92
  93
  94 /**
  95  * Function called by the transport for each received message.
  96  *
  97  * @param cls closure, const char* with the name of the plugin we received the message from
  98  * @param address address and (claimed) identity of the other peer
  99  * @param session identifier used for this session (NULL for plugins
 100  *                that do not offer bi-directional communication to the sender
 101  *                using the same "connection")
 102  * @param message the message, NULL if we only care about
 103  *                learning about the delay until we should receive again
 104  * @return how long the plugin should wait until receiving more data
 105  *         (plugins that do not support this, can ignore the return value)
 106  */
 107 struct GNUNET_TIME_Relative
 108 GST_receive_callback (void *cls,
 109                       const struct GNUNET_HELLO_Address *address,
 110                       struct Session *session,
 111                       const struct GNUNET_MessageHeader *message);
 112
 113
 114
 115
 116 #endif
 117 /* end of file gnunet-service-transport_plugins.h */