simplify logic

1 files changed, 58 insertions, 11 deletions

diff --git a/src/ats/gnunet-service-ats_plugins.h b/src/ats/gnunet-service-ats_plugins.h
index dd85bd361..7e093d940 100644
--- a/src/ats/gnunet-service-ats_plugins.h
+++ b/src/ats/gnunet-service-ats_plugins.h
@@ -108,6 +108,15 @@ GAS_normalized_property_changed (struct ATS_Address *address,
                                  double prop_rel);
 
 
+/**
+ * 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
+ * @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,
@@ -115,45 +124,83 @@ GAS_plugin_new_address (struct ATS_Address *new_address,
                         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);
 
 
+/**
+ * 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_preferences (void *client,
-                               const struct GNUNET_PeerIdentity *peer,
-                               enum GNUNET_ATS_PreferenceKind kind,
-                               float score_abs);
+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_preference_feedback (void *application,
+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);
 
 
-void
-GAS_plugin_delete_address (struct ATS_Address *address);
 
 
+/**
+ * Stop instant solving, there are many state updates
+ * happening in bulk right now.
+ */
 void
-GAS_plugin_request_connect_start (const struct GNUNET_PeerIdentity *pid);
+GAS_plugin_solver_lock (void);
 
 
+/**
+ * Resume instant solving, we are done with the bulk state updates.
+ */
 void
-GAS_plugin_request_connect_stop (const struct GNUNET_PeerIdentity *pid);
+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_solver_lock (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_solver_unlock (void);
+GAS_plugin_request_connect_stop (const struct GNUNET_PeerIdentity *pid);
 
 
 #endif