-skeletons for transport-ng
[oweals/gnunet.git] / src / ats / gnunet-service-ats_plugins.h
index 7e093d940258941c02082dd88e0fa8a71fc6d170..3f3261767e4857b915f0647572dfb61c093b6229 100644 (file)
@@ -1,6 +1,6 @@
 /*
  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
@@ -14,8 +14,8 @@
 
  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.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
  */
 
 /**
 #include "gnunet-service-ats_addresses.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
-};
-
-
 /**
  * Initialize address subsystem. The addresses subsystem manages the addresses
  * known and current performance information. It has a solver component
@@ -72,14 +41,14 @@ enum ATS_Mode
  *         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);
 
 
 /**
@@ -90,22 +59,18 @@ GAS_plugins_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);
 
 
 /**
@@ -114,28 +79,9 @@ GAS_normalized_property_changed (struct ATS_Address *address,
  *
  * @param new_address the new address
  * @param addr_net network scope the address is in
- * @param atsi performance data for the address
- * @param atsi_count size of the @a atsi array
  */
 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);
-
-
-/**
- * Tell the solver that updated performance data was
- * observed for the given address.
- *
- * @param new_address the new address
- * @param atsi updated performance data for the address
- * @param atsi_count size of the @a atsi array
- */
-void
-GAS_plugin_update_address (struct ATS_Address *address,
-                          const struct GNUNET_ATS_Information *atsi,
-                          uint32_t atsi_count);
+GAS_plugin_new_address (struct ATS_Address *new_address);
 
 
 /**
@@ -159,13 +105,11 @@ GAS_plugin_delete_address (struct ATS_Address *address);
  * @param score_abs degree of the appreciation
  */
 void
-GAS_plugin_preference_feedback (struct GNUNET_SERVER_Client *application,
-                               const struct GNUNET_PeerIdentity *peer,
-                               const struct GNUNET_TIME_Relative scope,
-                               enum GNUNET_ATS_PreferenceKind kind,
-                               float score_abs);
-
-
+GAS_plugin_notify_feedback (struct GNUNET_SERVER_Client *application,
+                            const struct GNUNET_PeerIdentity *peer,
+                            const struct GNUNET_TIME_Relative scope,
+                            enum GNUNET_ATS_PreferenceKind kind,
+                            float score_abs);
 
 
 /**