2 This file is part of GNUnet.
3 (C) 2011-2014 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_plugins.h
23 * @brief ats service plugin management
24 * @author Matthias Wachs
25 * @author Christian Grothoff
27 #ifndef GNUNET_SERVICE_ATS_PLUGINS_H
28 #define GNUNET_SERVICE_ATS_PLUGINS_H
30 #include "gnunet-service-ats_addresses.h"
34 * Available ressource assignment modes
41 * Assign each peer an equal amount of bandwidth (bw)
43 * bw_per_peer = bw_total / #active addresses
50 * Solve ressource assignment as an optimization problem
51 * Uses an mixed integer programming solver
56 * Reinforcement Learning mode:
58 * Solve resource assignment using a learning agent
65 * Initialize address subsystem. The addresses subsystem manages the addresses
66 * known and current performance information. It has a solver component
67 * responsible for the resource allocation. It tells the solver about changes
68 * and receives updates when the solver changes the ressource allocation.
70 * @param cfg configuration to use
71 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error (failed to load
75 GAS_plugins_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
79 * Shutdown address subsystem.
82 GAS_plugins_done (void);
86 * The preference changed for a peer, update solver.
88 * @param peer the peer
89 * @param kind the ATS kind
90 * @param pref_rel the new relative preference value
93 GAS_normalized_preference_changed (const struct GNUNET_PeerIdentity *peer,
94 enum GNUNET_ATS_PreferenceKind kind,
99 * The relative value for a property changed
101 * @param address the peer
102 * @param type the ATS type
103 * @param prop_rel the new relative preference value
106 GAS_normalized_property_changed (struct ATS_Address *address,
112 * Tell the solver that the given address can now be used
113 * for talking to the respective peer.
115 * @param new_address the new address
116 * @param addr_net network scope the address is in
117 * @param atsi performance data for the address
118 * @param atsi_count size of the @a atsi array
121 GAS_plugin_new_address (struct ATS_Address *new_address,
122 enum GNUNET_ATS_Network_Type addr_net,
123 const struct GNUNET_ATS_Information *atsi,
124 uint32_t atsi_count);
128 * Tell the solver that updated performance data was
129 * observed for the given address.
131 * @param new_address the new address
132 * @param atsi updated performance data for the address
133 * @param atsi_count size of the @a atsi array
136 GAS_plugin_update_address (struct ATS_Address *address,
137 const struct GNUNET_ATS_Information *atsi,
138 uint32_t atsi_count);
142 * Tell the solver that the given address is no longer valid
143 * can cannot be used any longer.
145 * @param address address that was deleted
148 GAS_plugin_delete_address (struct ATS_Address *address);
152 * Tell the solver that the given client has expressed its
153 * appreciation for the past performance of a given connection.
155 * @param application client providing the feedback
156 * @param peer peer the feedback is about
157 * @param scope timeframe the feedback applies to
158 * @param kind performance property the feedback relates to
159 * @param score_abs degree of the appreciation
162 GAS_plugin_preference_feedback (struct GNUNET_SERVER_Client *application,
163 const struct GNUNET_PeerIdentity *peer,
164 const struct GNUNET_TIME_Relative scope,
165 enum GNUNET_ATS_PreferenceKind kind,
172 * Stop instant solving, there are many state updates
173 * happening in bulk right now.
176 GAS_plugin_solver_lock (void);
180 * Resume instant solving, we are done with the bulk state updates.
183 GAS_plugin_solver_unlock (void);
187 * Notify the plugin that a request to connect to
188 * a particular peer was given to us.
190 * @param pid identity of peer we now care about
193 GAS_plugin_request_connect_start (const struct GNUNET_PeerIdentity *pid);
197 * Notify the plugin that a request to connect to
198 * a particular peer was dropped.
200 * @param pid identity of peer we care now less about
203 GAS_plugin_request_connect_stop (const struct GNUNET_PeerIdentity *pid);