src/ats/gnunet-service-ats_addresses_simplistic.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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 ats/gnunet-service-ats_addresses_simplistic.h
  23  * @brief ats simplistic ressource assignment
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_statistics_service.h"
  29 #include "gnunet-service-ats_addresses.h"
  30
  31 #define BIG_M_STRING "unlimited"
  32
  33 /**
  34  * Init the simplistic problem solving component
  35  *
  36  * Quotas:
  37  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
  38  * out_quota[i] contains outbound quota for network type i
  39  * in_quota[i] contains inbound quota for network type i
  40  *
  41  * Example
  42  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
  43  * network[2]   == GNUNET_ATS_NET_LAN
  44  * out_quota[2] == 65353
  45  * in_quota[2]  == 65353
  46  *
  47  * @param cfg configuration handle
  48  * @param stats the GNUNET_STATISTICS handle
  49  * @param network array of GNUNET_ATS_NetworkType with length dest_length
  50  * @param out_quota array of outbound quotas
  51  * @param in_quota array of outbound quota
  52  * @param dest_length array length for quota arrays
  53  * @param bw_changed_cb callback for changed bandwidth amounts
  54  * @param bw_changed_cb_cls cls for callback
  55  * @return handle for the solver on success, NULL on fail
  56  */
  57 void *
  58 GAS_simplistic_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
  59                      const struct GNUNET_STATISTICS_Handle *stats,
  60                      int *network,
  61                      unsigned long long *out_quota,
  62                      unsigned long long *in_quota,
  63                      int dest_length,
  64                      GAS_bandwidth_changed_cb bw_changed_cb,
  65                      void *bw_changed_cb_cls);
  66
  67 /**
  68  * Shutdown the simplistic problem solving component
  69  *
  70  * @param solver the respective handle to shutdown
  71  */
  72 void
  73 GAS_simplistic_done (void * solver);
  74
  75 /**
  76  * Add a single address to the solve
  77  *
  78  * @param solver the solver Handle
  79  * @param addresses the address hashmap containing all addresses
  80  * @param address the address to add
  81  */
  82 void
  83 GAS_simplistic_address_add (void *solver, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
  84
  85
  86 /**
  87  * Updates a single address in the solve
  88  *
  89  * @param solver the solver Handle
  90  * @param addresses the address hashmap containing all addresses
  91  * @param address the update address
  92  * @param session the new session (if changed otherwise current)
  93  * @param in_use the new address in use state (if changed otherwise current)
  94  * @param atsi the latest ATS information
  95  * @param atsi_count the atsi count
  96  */
  97 void
  98 GAS_simplistic_address_update (void *solver,
  99     struct GNUNET_CONTAINER_MultiHashMap *addresses,
 100     struct ATS_Address *address,
 101     uint32_t session,
 102     int in_use,
 103     const struct GNUNET_ATS_Information *atsi,
 104     uint32_t atsi_count);
 105
 106
 107 /**
 108  * Remove an address from the solver
 109  *
 110  * @param solver the solver handle
 111  * @param addresses the address hashmap containing all addresses
 112  * @param address the address to remove
 113  * @param session_only delete only session not whole address
 114  */
 115 void
 116 GAS_simplistic_address_delete (void *solver,
 117     struct GNUNET_CONTAINER_MultiHashMap * addresses,
 118     struct ATS_Address *address, int session_only);
 119
 120
 121 /**
 122  * Get the prefered address for a specific peer
 123  *
 124  * @param solver the solver handle
 125  * @param addresses the address hashmap containing all addresses
 126  * @param peer the identity of the peer
 127  */
 128 const struct ATS_Address *
 129 GAS_simplistic_get_preferred_address (void *solver,
 130                                struct GNUNET_CONTAINER_MultiHashMap * addresses,
 131                                const struct GNUNET_PeerIdentity *peer);
 132
 133
 134 /**
 135  * Changes the preferences for a peer in the problem
 136  *
 137  * @param solver the solver handle
 138  * @param client the client with this preference
 139  * @param peer the peer to change the preference for
 140  * @param kind the kind to change the preference
 141  * @param score the score
 142  */
 143 void
 144 GAS_simplistic_address_change_preference (void *solver,
 145                                    void *client,
 146                                    const struct GNUNET_PeerIdentity *peer,
 147                                    enum GNUNET_ATS_PreferenceKind kind,
 148                                    float score);
 149
 150
 151 /* end of gnunet-service-ats_addresses_simplistic.h */