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