src/transport/gnunet-service-transport.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010,2011 GNUnet e.V.
   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  * Continuation called from a blacklist test.
  96  *
  97  * @param cls closure
  98  * @param peer identity of peer that was tested
  99  * @param address address associated with the request
 100  * @param session session associated with the request
 101  * @param result #GNUNET_OK if the connection is allowed,
 102  *               #GNUNET_NO if not,
 103  *               #GNUNET_SYSERR if operation was aborted
 104  */
 105 typedef void
 106 (*GST_BlacklistTestContinuation) (void *cls,
 107                                   const struct GNUNET_PeerIdentity *peer,
 108                                   const struct GNUNET_HELLO_Address *address,
 109                                   struct GNUNET_ATS_Session *session,
 110                                   int result);
 111
 112
 113 /**
 114  * Add the given peer to the blacklist (for the given transport).
 115  *
 116  * @param peer peer to blacklist
 117  * @param transport_name transport to blacklist for this peer, NULL for all
 118  */
 119 void
 120 GST_blacklist_add_peer (const struct GNUNET_PeerIdentity *peer,
 121                         const char *transport_name);
 122
 123
 124 /**
 125  * Handle to an active blacklist check.
 126  */
 127 struct GST_BlacklistCheck;
 128
 129
 130
 131 /**
 132  * Test if a peer/transport combination is blacklisted.
 133  *
 134  * @param peer the identity of the peer to test
 135  * @param transport_name name of the transport to test, never NULL
 136  * @param cont function to call with result
 137  * @param cont_cls closure for @a cont
 138  * @param address address to pass back to @a cont, can be NULL
 139  * @param session session to pass back to @a cont, can be NULL
 140  * @return handle to the blacklist check, NULL if the decision
 141  *        was made instantly and @a cont was already called
 142  */
 143 struct GST_BlacklistCheck *
 144 GST_blacklist_test_allowed (const struct GNUNET_PeerIdentity *peer,
 145                             const char *transport_name,
 146                             GST_BlacklistTestContinuation cont,
 147                             void *cont_cls,
 148                             const struct GNUNET_HELLO_Address *address,
 149                             struct GNUNET_ATS_Session *session);
 150
 151
 152 /**
 153  * Abort blacklist if @a address and @a session match.
 154  *
 155  * @param address address used to abort matching checks
 156  * @param session session used to abort matching checks
 157  */
 158 void
 159 GST_blacklist_abort_matching (const struct GNUNET_HELLO_Address *address,
 160                               struct GNUNET_ATS_Session *session);
 161
 162 /**
 163  * Cancel a blacklist check.
 164  *
 165  * @param bc check to cancel
 166  */
 167 void
 168 GST_blacklist_test_cancel (struct GST_BlacklistCheck *bc);
 169
 170
 171 /**
 172  * Function called by the transport for each received message.
 173  *
 174  * @param cls closure, const char* with the name of the plugin we received the message from
 175  * @param address address and (claimed) identity of the other peer
 176  * @param session identifier used for this session (NULL for plugins
 177  *                that do not offer bi-directional communication to the sender
 178  *                using the same "connection")
 179  * @param message the message, NULL if we only care about
 180  *                learning about the delay until we should receive again
 181  * @return how long the plugin should wait until receiving more data
 182  *         (plugins that do not support this, can ignore the return value)
 183  */
 184 struct GNUNET_TIME_Relative
 185 GST_receive_callback (void *cls,
 186                       const struct GNUNET_HELLO_Address *address,
 187                       struct GNUNET_ATS_Session *session,
 188                       const struct GNUNET_MessageHeader *message);
 189
 190 /**
 191  * Broadcast the given message to all of our clients.
 192  *
 193  * @param msg message to broadcast
 194  * @param may_drop #GNUNET_YES if the message can be dropped / is payload
 195  */
 196 void
 197 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
 198                        int may_drop);
 199
 200
 201 /**
 202  * Broadcast the new active address to all clients monitoring the peer.
 203  *
 204  * @param peer peer this update is about (never NULL)
 205  * @param address address, NULL on disconnect
 206  * @param state the current state of the peer
 207  * @param state_timeout the time out for the state
 208  */
 209 void
 210 GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer,
 211                                          const struct GNUNET_HELLO_Address *address,
 212                                          enum GNUNET_TRANSPORT_PeerState state,
 213                                          struct GNUNET_TIME_Absolute state_timeout);
 214
 215
 216 /**
 217  * Notify all clients about a disconnect, and cancel
 218  * pending SEND_OK messages for this peer.
 219  *
 220  * @param peer peer that disconnected
 221  */
 222 void
 223 GST_clients_broadcast_disconnect (const struct GNUNET_PeerIdentity *peer);
 224
 225
 226
 227
 228 #endif
 229 /* end of file gnunet-service-transport_plugins.h */