/*
This file is part of GNUnet.
- (C) 2011-2014 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2011-2014 GNUnet e.V.
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Affero General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
#ifndef GNUNET_SERVICE_ATS_PLUGINS_H
#define GNUNET_SERVICE_ATS_PLUGINS_H
-#include "gnunet_util_lib.h"
-#include "gnunet_ats_service.h"
-#include "gnunet-service-ats.h"
#include "gnunet-service-ats_addresses.h"
-#include "gnunet_statistics_service.h"
-#include "ats.h"
-
-
-/**
- * Available ressource assignment modes
- */
-enum ATS_Mode
-{
- /**
- * proportional mode:
- *
- * Assign each peer an equal amount of bandwidth (bw)
- *
- * bw_per_peer = bw_total / #active addresses
- */
- MODE_PROPORTIONAL,
-
- /**
- * MLP mode:
- *
- * Solve ressource assignment as an optimization problem
- * Uses an mixed integer programming solver
- */
- MODE_MLP,
-
- /**
- * Reinforcement Learning mode:
- *
- * Solve resource assignment using a learning agent
- */
- MODE_RIL
-};
/**
* solver plugin)
*/
int
-GAS_plugins_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
+GAS_plugin_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* Shutdown address subsystem.
*/
void
-GAS_plugins_done (void);
+GAS_plugin_done (void);
/**
* @param pref_rel the new relative preference value
*/
void
-GAS_normalized_preference_changed (const struct GNUNET_PeerIdentity *peer,
- enum GNUNET_ATS_PreferenceKind kind,
- double pref_rel);
+GAS_plugin_notify_preference_changed (const struct GNUNET_PeerIdentity *peer,
+ enum GNUNET_ATS_PreferenceKind kind,
+ double pref_rel);
/**
- * The relative value for a property changed
+ * The relative value for a property changed.
*
* @param address the peer
- * @param type the ATS type
- * @param prop_rel the new relative preference value
*/
void
-GAS_normalized_property_changed (struct ATS_Address *address,
- uint32_t type,
- double prop_rel);
+GAS_plugin_notify_property_changed (struct ATS_Address *address);
+/**
+ * Tell the solver that the given address can now be used
+ * for talking to the respective peer.
+ *
+ * @param new_address the new address
+ * @param addr_net network scope the address is in
+ */
void
-GAS_plugin_new_address (struct ATS_Address *new_address,
- enum GNUNET_ATS_Network_Type addr_net,
- const struct GNUNET_ATS_Information *atsi,
- uint32_t atsi_count);
+GAS_plugin_new_address (struct ATS_Address *new_address);
+/**
+ * Tell the solver that the given address is no longer valid
+ * can cannot be used any longer.
+ *
+ * @param address address that was deleted
+ */
void
-GAS_plugin_update_address (struct ATS_Address *address,
- const struct GNUNET_ATS_Information *atsi,
- uint32_t atsi_count);
+GAS_plugin_delete_address (struct ATS_Address *address);
+/**
+ * Tell the solver that the given client has expressed its
+ * appreciation for the past performance of a given connection.
+ *
+ * @param application client providing the feedback
+ * @param peer peer the feedback is about
+ * @param scope timeframe the feedback applies to
+ * @param kind performance property the feedback relates to
+ * @param score_abs degree of the appreciation
+ */
void
-GAS_plugin_update_preferences (void *client,
- const struct GNUNET_PeerIdentity *peer,
- enum GNUNET_ATS_PreferenceKind kind,
- float score_abs);
+GAS_plugin_notify_feedback (struct GNUNET_SERVICE_Client *application,
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_TIME_Relative scope,
+ enum GNUNET_ATS_PreferenceKind kind,
+ float score_abs);
+/**
+ * Stop instant solving, there are many state updates
+ * happening in bulk right now.
+ */
void
-GAS_plugin_preference_feedback (void *application,
- const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_TIME_Relative scope,
- enum GNUNET_ATS_PreferenceKind kind,
- float score_abs);
+GAS_plugin_solver_lock (void);
+/**
+ * Resume instant solving, we are done with the bulk state updates.
+ */
void
-GAS_plugin_delete_address (struct ATS_Address *address);
+GAS_plugin_solver_unlock (void);
+/**
+ * Notify the plugin that a request to connect to
+ * a particular peer was given to us.
+ *
+ * @param pid identity of peer we now care about
+ */
void
GAS_plugin_request_connect_start (const struct GNUNET_PeerIdentity *pid);
+/**
+ * Notify the plugin that a request to connect to
+ * a particular peer was dropped.
+ *
+ * @param pid identity of peer we care now less about
+ */
void
GAS_plugin_request_connect_stop (const struct GNUNET_PeerIdentity *pid);
-void
-GAS_plugin_solver_lock (void);
-
-
-void
-GAS_plugin_solver_unlock (void);
-
-
#endif
projects / oweals / gnunet.git / blobdiff