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
39 * Init the proportional problem solver
42 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
43 * out_quota[i] contains outbound quota for network type i
44 * in_quota[i] contains inbound quota for network type i
47 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
48 * network[2] == GNUNET_ATS_NET_LAN
49 * out_quota[2] == 65353
50 * in_quota[2] == 65353
52 * @param cfg configuration handle
53 * @param stats the GNUNET_STATISTICS handle
54 * @param network array of GNUNET_ATS_NetworkType with length dest_length
55 * @param out_quota array of outbound quotas
56 * @param in_quota array of outbound quota
57 * @param dest_length array length for quota arrays
58 * @param bw_changed_cb callback for changed bandwidth amounts
59 * @param bw_changed_cb_cls cls for callback
60 * @return handle for the solver on success, NULL on fail
63 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
64 const struct GNUNET_STATISTICS_Handle *stats,
66 unsigned long long *out_quota,
67 unsigned long long *in_quota,
69 GAS_bandwidth_changed_cb bw_changed_cb,
70 void *bw_changed_cb_cls);
74 * Shutdown the proportional problem solver
76 * @param solver the respective handle to shutdown
79 GAS_proportional_done (void * solver);
83 * Add a single address within a network to the solver
85 * @param solver the solver Handle
86 * @param addresses the address hashmap containing all addresses
87 * @param address the address to add
88 * @param network network type of this address
91 GAS_proportional_address_add (void *solver,
92 struct GNUNET_CONTAINER_MultiHashMap *addresses,
93 struct ATS_Address *address,
98 * Updates a single address in the solve
100 * @param solver the solver Handle
101 * @param addresses the address hashmap containing all addresses
102 * @param address the update address
103 * @param session the new session (if changed otherwise current)
104 * @param in_use the new address in use state (if changed otherwise current)
105 * @param prev_ats the latest ATS information
106 * @param prev_atsi_count the atsi count
109 GAS_proportional_address_update (void *solver,
110 struct GNUNET_CONTAINER_MultiHashMap *addresses,
111 struct ATS_Address *address,
114 const struct GNUNET_ATS_Information *atsi,
115 uint32_t atsi_count);
119 * Remove an address from the solver
121 * @param solver the solver handle
122 * @param addresses the address hashmap containing all addresses
123 * @param address the address to remove
124 * @param session_only delete only session not whole address
127 GAS_proportional_address_delete (void *solver,
128 struct GNUNET_CONTAINER_MultiHashMap * addresses,
129 struct ATS_Address *address, int session_only);
133 * Stop notifying about address and bandwidth changes for this peer
135 * @param solver the MLP handle
136 * @param addresses address hashmap
137 * @param peer the peer
140 GAS_proportional_stop_get_preferred_address (void *solver,
141 struct GNUNET_CONTAINER_MultiHashMap *addresses,
142 const struct GNUNET_PeerIdentity *peer);
146 * Get the prefered address for a specific peer
148 * @param solver the solver handle
149 * @param addresses the address hashmap containing all addresses
150 * @param peer the identity of the peer
152 const struct ATS_Address *
153 GAS_proportional_get_preferred_address (void *solver,
154 struct GNUNET_CONTAINER_MultiHashMap * addresses,
155 const struct GNUNET_PeerIdentity *peer);
159 * Changes the preferences for a peer in the problem
161 * @param solver the solver handle
162 * @param client the client with this preference
163 * @param peer the peer to change the preference for
164 * @param kind the kind to change the preference
165 * @param score the score
168 GAS_simplistic_address_change_preference (void *solver,
170 const struct GNUNET_PeerIdentity *peer,
171 enum GNUNET_ATS_PreferenceKind kind,
175 /* end of gnunet-service-ats-solver_proportional.c */