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  * @return handle for the solver on success, NULL on fail
  53  */
  54 void *
  55 GAS_simplistic_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
  56                      const struct GNUNET_STATISTICS_Handle *stats,
  57                      int *network,
  58                      unsigned long long *out_quota,
  59                      unsigned long long *in_quota,
  60                      int dest_length);
  61
  62 /**
  63  * Shutdown the simplistic problem solving component
  64  *
  65  * @param solver the respective handle to shutdown
  66  */
  67 void
  68 GAS_simplistic_done (void * solver);
  69
  70 /**
  71  * Add a single address to the solve
  72  *
  73  * @param solver the solver Handle
  74  * @param addresses the address hashmap containing all addresses
  75  * @param address the address to add
  76  */
  77 void
  78 GAS_simplistic_address_add (void *solver, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
  79
  80
  81 /**
  82  * Updates a single address in the solve
  83  *
  84  * @param solver the solver Handle
  85  * @param addresses the address hashmap containing all addresses
  86  * @param address the update address
  87  */
  88 void
  89 GAS_simplistic_address_update (void *solver, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
  90
  91
  92 /**
  93  * Remove an address from the solver
  94  *
  95  * @param solver the solver handle
  96  * @param addresses the address hashmap containing all addresses
  97  * @param address the address to remove
  98  */
  99 void
 100 GAS_simplistic_address_delete (void *solver, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
 101
 102
 103 /**
 104  * Get the prefered address for a specific peer
 105  *
 106  * @param solver the solver handle
 107  * @param addresses the address hashmap containing all addresses
 108  * @param peer the identity of the peer
 109  */
 110 const struct ATS_Address *
 111 GAS_simplistic_get_preferred_address (void *solver,
 112                                struct GNUNET_CONTAINER_MultiHashMap * addresses,
 113                                const struct GNUNET_PeerIdentity *peer);
 114
 115
 116 /**
 117  * Changes the preferences for a peer in the problem
 118  *
 119  * @param solver the solver handle
 120  * @param peer the peer to change the preference for
 121  * @param kind the kind to change the preference
 122  * @param score the score
 123  */
 124 void
 125 GAS_simplistic_address_change_preference (void *solver,
 126                                    const struct GNUNET_PeerIdentity *peer,
 127                                    enum GNUNET_ATS_PreferenceKind kind,
 128                                    float score);
 129
 130
 131 /* end of gnunet-service-ats_addresses_simplistic.h */