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 peer the peer to change the preference for
42 * @param kind the kind to change the preference
43 * @param pref_rel the normalized preference value for this kind over all clients
46 GAS_proportional_address_change_preference (void *solver,
47 const struct GNUNET_PeerIdentity *peer,
48 enum GNUNET_ATS_PreferenceKind kind,
53 * Get application feedback for a peer
55 * @param solver the solver handle
56 * @param application the application
57 * @param peer the peer to change the preference for
58 * @param kind the kind to change the preference
59 * @param score the score
62 GAS_proportional_address_preference_feedback (void *solver,
64 const struct GNUNET_PeerIdentity *peer,
65 enum GNUNET_ATS_PreferenceKind kind,
70 * Init the proportional problem solver
73 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
74 * out_quota[i] contains outbound quota for network type i
75 * in_quota[i] contains inbound quota for network type i
78 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
79 * network[2] == GNUNET_ATS_NET_LAN
80 * out_quota[2] == 65353
81 * in_quota[2] == 65353
83 * @param cfg configuration handle
84 * @param stats the GNUNET_STATISTICS handle
85 * @param network array of GNUNET_ATS_NetworkType with length dest_length
86 * @param addresses hashmap containing all addresses
87 * @param out_quota array of outbound quotas
88 * @param in_quota array of outbound quota
89 * @param dest_length array length for quota arrays
90 * @param bw_changed_cb callback for changed bandwidth amounts
91 * @param bw_changed_cb_cls cls for callback
92 * @param get_preference callback to get relative preferences for a peer
93 * @param get_preference_cls cls for callback to get relative preferences
94 * @param get_properties_cls for callback to get relative properties
95 * @param get_properties_cls cls for callback to get relative properties
96 * @return handle for the solver on success, NULL on fail
99 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
100 const struct GNUNET_STATISTICS_Handle *stats,
101 const struct GNUNET_CONTAINER_MultiHashMap *addresses,
103 unsigned long long *out_quota,
104 unsigned long long *in_quota,
106 GAS_bandwidth_changed_cb bw_changed_cb,
107 void *bw_changed_cb_cls,
108 GAS_get_preferences get_preference,
109 void *get_preference_cls,
110 GAS_get_properties get_properties,
111 void *get_properties_cls);
114 * Shutdown the proportional problem solver
116 * @param solver the respective handle to shutdown
119 GAS_proportional_done (void * solver);
123 * Add a single address within a network to the solver
125 * @param solver the solver Handle
126 * @param address the address to add
127 * @param network network type of this address
130 GAS_proportional_address_add (void *solver,
131 struct ATS_Address *address,
136 * Transport properties for this address have changed
138 * @param solver solver handle
139 * @param address the address
140 * @param type the ATSI type in HBO
141 * @param abs_value the absolute value of the property
142 * @param rel_value the normalized value
145 GAS_proportional_address_property_changed (void *solver,
146 struct ATS_Address *address,
153 * Transport session for this address has changed
155 * NOTE: values in addresses are already updated
157 * @param solver solver handle
158 * @param address the address
159 * @param cur_session the current session
160 * @param new_session the new session
163 GAS_proportional_address_session_changed (void *solver,
164 struct ATS_Address *address,
165 uint32_t cur_session,
166 uint32_t new_session);
170 * Usage for this address has changed
172 * NOTE: values in addresses are already updated
174 * @param solver solver handle
175 * @param address the address
176 * @param in_use usage state
179 GAS_proportional_address_inuse_changed (void *solver,
180 struct ATS_Address *address,
184 * Network scope for this address has changed
186 * NOTE: values in addresses are already updated
188 * @param solver solver handle
189 * @param address the address
190 * @param current_network the current network
191 * @param new_network the new network
194 GAS_proportional_address_change_network (void *solver,
195 struct ATS_Address *address,
196 uint32_t current_network,
197 uint32_t new_network);
200 * Remove an address from the solver
202 * @param solver the solver handle
203 * @param address the address to remove
204 * @param session_only delete only session not whole address
207 GAS_proportional_address_delete (void *solver,
208 struct ATS_Address *address, int session_only);
212 * Start a bulk operation
214 * @param solver the solver
217 GAS_proportional_bulk_start (void *solver);
221 * Bulk operation done
224 GAS_proportional_bulk_stop (void *solver);
227 * Stop notifying about address and bandwidth changes for this peer
229 * @param solver the proportional handle
230 * @param peer the peer
233 GAS_proportional_stop_get_preferred_address (void *solver,
234 const struct GNUNET_PeerIdentity *peer);
238 * Get the prefered address for a specific peer
240 * @param solver the solver handle
241 * @param peer the identity of the peer
243 const struct ATS_Address *
244 GAS_proportional_get_preferred_address (void *solver,
245 const struct GNUNET_PeerIdentity *peer);
247 /* end of gnunet-service-ats-solver_proportional.c */