more work on route_message() logic
[oweals/gnunet.git] / src / ats / gnunet-service-ats_preferences.h
index ee8c931d6f30ce95ef97c0d75a84138cdb34b169..e0c7aa2e35f2dc196d38dd9ae71ca87e04da9464 100644 (file)
@@ -1,26 +1,25 @@
 /*
  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
+ */
 /**
  * @file ats/gnunet-service-ats_preferences.h
- * @brief FIXME
+ * @brief manage preferences expressed by clients
  * @author Matthias Wachs
  * @author Christian Grothoff
  */
 #include "gnunet_statistics_service.h"
 #include "ats.h"
 
-
-#define DEFAULT_ABS_PREFERENCE 0.0
-
-#define DEFAULT_REL_PREFERENCE 0.0
-
-
-/**
- * A preference client disconnected.
- *
- * @param client the client
- */
-void
-GAS_preference_client_disconnect (struct GNUNET_SERVER_Client *client);
-
-
 /**
- * Get the normalized preference values for a specific peer.
- *
- * @param cls ignored
- * @param id the peer
- * @return pointer to the values, can be indexed
- *  with GNUNET_ATS_PreferenceKind, NULL if peer does not exist
+ * Default preference value we assume if we know nothing.
  */
-const double *
-GAS_normalization_get_preferences_by_peer (void *cls,
-                                          const struct GNUNET_PeerIdentity *id);
-
+#define DEFAULT_ABS_PREFERENCE 0.0
 
 /**
- * Get the normalized preference values for a specific client and peer
- *
- * @param client client
- * @param peer the peer
- * @param pref the preference type
- * @return the value
+ * Default relative preference value we assume if we know nothing.
  */
-double
-GAS_normalization_get_preferences_by_client (const struct GNUNET_SERVER_Client *client,
-                                             const struct GNUNET_PeerIdentity *peer,
-                                             enum GNUNET_ATS_PreferenceKind pref);
+#define DEFAULT_REL_PREFERENCE 0.0
 
 
 /**
- * Normalize an updated preference value
+ * Handle 'preference change' messages from clients.
  *
- * @param client the client with this preference
- * @param peer the peer to change the preference for
- * @param kind the kind to change the preference
- * @param score_abs the normalized score
+ * @param client the client that sent the request
+ * @param msg the request message
  */
 void
-GAS_normalization_normalize_preference (struct GNUNET_SERVER_Client *client,
-                                        const struct GNUNET_PeerIdentity *peer,
-                                        enum GNUNET_ATS_PreferenceKind kind,
-                                        float score_abs);
+GAS_handle_preference_change (struct GNUNET_SERVICE_Client *client,
+                             const struct ChangePreferenceMessage *msg);
 
 
 /**
- * A performance client disconnected
- *
- * @param client the disconnecting client
+ * Initialize preferences subsystem.
  */
 void
-GAS_normalization_preference_client_disconnect (struct GNUNET_SERVER_Client *client);
+GAS_preference_init (void);
 
 
 /**
- * Handle 'preference change' messages from clients.
- *
- * @param cls unused, NULL
- * @param client client that sent the request
- * @param message the request message
+ * Shutdown preferences subsystem.
  */
 void
-GAS_handle_preference_change (void *cls,
-                              struct GNUNET_SERVER_Client *client,
-                              const struct GNUNET_MessageHeader *message);
+GAS_preference_done (void);
 
 
 /**
- * Initialize preferences subsystem.
+ * Get the normalized preference values for a specific peer.
+ *
+ * @param cls ignored
+ * @param id the peer
+ * @return pointer to the values, can be indexed
+ *  with `enum GNUNET_ATS_PreferenceKind`, never NULL
  */
-void
-GAS_preference_init (void);
+const double *
+GAS_preference_get_by_peer (void *cls,
+                            const struct GNUNET_PeerIdentity *id);
 
 
 /**
- * Shutdown preferences subsystem.
+ * A performance client disconnected
+ *
+ * @param client the disconnecting client
  */
 void
-GAS_preference_done (void);
+GAS_preference_client_disconnect (struct GNUNET_SERVICE_Client *client);
 
 
 #endif