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