changes
[oweals/gnunet.git] / src / ats / gnunet-service-ats_normalization.h
1 /*
2      This file is part of GNUnet.
3      (C) 2011 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file ats/gnunet-service-ats_normalization.h
23  * @brief ats service address: management of ATS properties and preferences normalization
24  * @author Matthias Wachs
25  * @author Christian Grothoff
26  */
27 #include "platform.h"
28 #include "gnunet_ats_service.h"
29
30 #define PREF_AGING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
31 #define PREF_AGING_FACTOR 0.95
32
33 #define DEFAULT_REL_PREFERENCE 1.0
34 #define DEFAULT_ABS_PREFERENCE 0.0
35
36
37 typedef void
38 (*GAS_Normalization_preference_changed_cb) (void *cls,
39                                                                                                                                                                                 const struct GNUNET_PeerIdentity *peer,
40                                                                                                                                                                                 enum GNUNET_ATS_PreferenceKind kind,
41                                                                                                                                                                                 double pref_rel);
42
43 /**
44  * Get the normalized preference values for a specific peer
45  *
46  * @param id the peer
47  * @return pointer to the values, can be indexed with GNUNET_ATS_PreferenceKind, NULL if peer does not exist
48  */
49 const double *
50 GAS_normalization_get_preferences (struct GNUNET_PeerIdentity *id);
51
52 /**
53  * Changes the preferences for a peer in the problem
54  *
55  * @param solver the solver handle
56  * @param client the client with this preference
57  * @param peer the peer to change the preference for
58  * @param kind the kind to change the preference
59  * @param score the normalized score
60  */
61 float
62 GAS_normalization_change_preference (void *src,
63                                          const struct GNUNET_PeerIdentity *peer,
64                                          enum GNUNET_ATS_PreferenceKind kind,
65                                          float score_abs);
66
67 void
68 GAS_normalization_start (GAS_Normalization_preference_changed_cb pref_ch_cb, void *pref_ch_cb_cls);
69
70 void
71 GAS_normalization_stop ();
72
73
74 /* end of gnunet-service-ats_normalization.h */