src/transport/gnunet-service-transport.h

   1 /*
   2      This file is part of GNUnet.
   3      (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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, 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 /**
  68  * Function to call when a peer's address has changed
  69  *
  70  * @param cls closure
  71  * @param peer peer this update is about,
  72  * @param address address, NULL for disconnect notification
  73  */
  74 typedef void
  75 (*GNUNET_TRANSPORT_NeighbourChangeCallback) (void *cls,
  76     const struct GNUNET_PeerIdentity *peer,
  77     const struct GNUNET_HELLO_Address *address,
  78     enum GNUNET_TRANSPORT_PeerState state,
  79     struct GNUNET_TIME_Absolute state_timeout,
  80     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
  81     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
  82
  83
  84 /**
  85  * Function called by the transport for each received message.
  86  *
  87  * @param cls closure, const char* with the name of the plugin we received the message from
  88  * @param address address and (claimed) identity of the other peer
  89  * @param session identifier used for this session (NULL for plugins
  90  *                that do not offer bi-directional communication to the sender
  91  *                using the same "connection")
  92  * @param message the message, NULL if we only care about
  93  *                learning about the delay until we should receive again
  94  * @return how long the plugin should wait until receiving more data
  95  *         (plugins that do not support this, can ignore the return value)
  96  */
  97 struct GNUNET_TIME_Relative
  98 GST_receive_callback (void *cls,
  99                       const struct GNUNET_HELLO_Address *address,
 100                       struct Session *session,
 101                       const struct GNUNET_MessageHeader *message);
 102
 103
 104 #endif
 105 /* end of file gnunet-service-transport_plugins.h */