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_transport_service.h"
  32
  33 #define VERBOSE_VALIDATION GNUNET_YES
  34
  35 /**
  36  * Statistics handle.
  37  */
  38 extern struct GNUNET_STATISTICS_Handle *GST_stats;
  39
  40 /**
  41  * Configuration handle.
  42  */
  43 extern const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
  44
  45 /**
  46  * Configuration handle.
  47  */
  48 extern struct GNUNET_PeerIdentity GST_my_identity;
  49
  50 /**
  51  * Handle to peerinfo service.
  52  */
  53 extern struct GNUNET_PEERINFO_Handle *GST_peerinfo;
  54
  55 /**
  56  * Our private key.
  57  */
  58 extern struct GNUNET_CRYPTO_EddsaPrivateKey *GST_my_private_key;
  59
  60 /**
  61  * ATS handle.
  62  */
  63 extern struct GNUNET_ATS_SchedulingHandle *GST_ats;
  64
  65 /**
  66  * Function called by the transport for each received message.
  67  * This function should also be called with "NULL" for the
  68  * message to signal that the other peer disconnected.
  69  *
  70  * @param cls closure, const char* with the name of the plugin we received the message from
  71  * @param peer (claimed) identity of the other peer
  72  * @param message the message, NULL if we only care about
  73  *                learning about the delay until we should receive again -- FIXME!
  74  * @param session identifier used for this session (NULL for plugins
  75  *                that do not offer bi-directional communication to the sender
  76  *                using the same "connection")
  77  * @param sender_address binary address of the sender (if we established the
  78  *                connection or are otherwise sure of it; should be NULL
  79  *                for inbound TCP/UDP connections since it it not clear
  80  *                that we could establish ourselves a connection to that
  81  *                IP address and get the same system)
  82  * @param sender_address_len number of bytes in sender_address
  83  * @return how long the plugin should wait until receiving more data
  84  *         (plugins that do not support this, can ignore the return value)
  85  */
  86 struct GNUNET_TIME_Relative
  87 GST_receive_callback (void *cls,
  88                       const struct GNUNET_PeerIdentity *peer,
  89                       const struct GNUNET_MessageHeader *message,
  90                       struct Session *session,
  91                       const char *sender_address,
  92                       uint16_t sender_address_len);
  93
  94
  95 /**
  96  * Notify ATS about the new address including the network this address is
  97  * located in.
  98  *
  99  * @param address the address
 100  * @param session the session
 101  * @param ats ats information
 102  * @param ats_count number of @a ats information
 103  */
 104 void
 105 GST_ats_add_address (const struct GNUNET_HELLO_Address *address,
 106                      struct Session *session,
 107                      const struct GNUNET_ATS_Information *ats,
 108                      uint32_t ats_count);
 109
 110
 111 /**
 112  * Notify ATS about property changes to an address
 113  *
 114  * @param peer the peer
 115  * @param address the address
 116  * @param session the session
 117  * @param ats performance information
 118  * @param ats_count number of elements in @a ats
 119  */
 120 void
 121 GST_ats_update_metrics (const struct GNUNET_PeerIdentity *peer,
 122                         const struct GNUNET_HELLO_Address *address,
 123                         struct Session *session,
 124                         const struct GNUNET_ATS_Information *ats,
 125                         uint32_t ats_count);
 126
 127 #endif
 128 /* end of file gnunet-service-transport_plugins.h */