2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file ats/gnunet-service-ats-solver_proportional.h
23 * @brief ATS proportional solver
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet_statistics_service.h"
29 #include "gnunet-service-ats_addresses.h"
32 * ATS proportional solver
38 * Changes the preferences for a peer in the problem
40 * @param solver the solver handle
41 * @param client the client with this preference
42 * @param peer the peer to change the preference for
43 * @param kind the kind to change the preference
44 * @param pref_rel the normalized preference value for this kind over all clients
45 * @param score the score
48 GAS_proportional_address_change_preference (void *solver,
50 const struct GNUNET_PeerIdentity *peer,
51 enum GNUNET_ATS_PreferenceKind kind,
56 * Init the proportional problem solver
59 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
60 * out_quota[i] contains outbound quota for network type i
61 * in_quota[i] contains inbound quota for network type i
64 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
65 * network[2] == GNUNET_ATS_NET_LAN
66 * out_quota[2] == 65353
67 * in_quota[2] == 65353
69 * @param cfg configuration handle
70 * @param stats the GNUNET_STATISTICS handle
71 * @param network array of GNUNET_ATS_NetworkType with length dest_length
72 * @param out_quota array of outbound quotas
73 * @param in_quota array of outbound quota
74 * @param dest_length array length for quota arrays
75 * @param bw_changed_cb callback for changed bandwidth amounts
76 * @param bw_changed_cb_cls cls for callback
77 * @return handle for the solver on success, NULL on fail
80 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
81 const struct GNUNET_STATISTICS_Handle *stats,
83 unsigned long long *out_quota,
84 unsigned long long *in_quota,
86 GAS_bandwidth_changed_cb bw_changed_cb,
87 void *bw_changed_cb_cls);
91 * Shutdown the proportional problem solver
93 * @param solver the respective handle to shutdown
96 GAS_proportional_done (void * solver);
100 * Add a single address within a network to the solver
102 * @param solver the solver Handle
103 * @param addresses the address hashmap containing all addresses
104 * @param address the address to add
105 * @param network network type of this address
108 GAS_proportional_address_add (void *solver,
109 struct GNUNET_CONTAINER_MultiHashMap *addresses,
110 struct ATS_Address *address,
115 * Updates a single address in the solve
117 * @param solver the solver Handle
118 * @param addresses the address hashmap containing all addresses
119 * @param address the update address
120 * @param session the new session (if changed otherwise current)
121 * @param in_use the new address in use state (if changed otherwise current)
122 * @param prev_ats the latest ATS information
123 * @param prev_atsi_count the atsi count
126 GAS_proportional_address_update (void *solver,
127 struct GNUNET_CONTAINER_MultiHashMap *addresses,
128 struct ATS_Address *address,
131 const struct GNUNET_ATS_Information *atsi,
132 uint32_t atsi_count);
136 * Remove an address from the solver
138 * @param solver the solver handle
139 * @param addresses the address hashmap containing all addresses
140 * @param address the address to remove
141 * @param session_only delete only session not whole address
144 GAS_proportional_address_delete (void *solver,
145 struct GNUNET_CONTAINER_MultiHashMap * addresses,
146 struct ATS_Address *address, int session_only);
150 * Stop notifying about address and bandwidth changes for this peer
152 * @param solver the MLP handle
153 * @param addresses address hashmap
154 * @param peer the peer
157 GAS_proportional_stop_get_preferred_address (void *solver,
158 struct GNUNET_CONTAINER_MultiHashMap *addresses,
159 const struct GNUNET_PeerIdentity *peer);
163 * Get the prefered address for a specific peer
165 * @param solver the solver handle
166 * @param addresses the address hashmap containing all addresses
167 * @param peer the identity of the peer
169 const struct ATS_Address *
170 GAS_proportional_get_preferred_address (void *solver,
171 struct GNUNET_CONTAINER_MultiHashMap * addresses,
172 const struct GNUNET_PeerIdentity *peer);
174 /* end of gnunet-service-ats-solver_proportional.c */