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 #ifndef GNUNET_SERVICE_ATS_NORMALIZATION_H
  28 #define GNUNET_SERVICE_ATS_NORMALIZATION_H
  29 #include "gnunet_ats_service.h"
  30
  31 #define DEFAULT_REL_QUALITY 1.0
  32
  33
  34 /**
  35  * Get the normalized preference values for a specific peer
  36  *
  37  * @param cls ignored
  38  * @param id the peer @return pointer to the values, can be indexed
  39  * with GNUNET_ATS_PreferenceKind, NULL if peer does not exist
  40  */
  41 const double *
  42 GAS_normalization_get_preferences_by_peer (void *cls,
  43                                            const struct GNUNET_PeerIdentity *id);
  44
  45
  46 /**
  47  * Get the normalized properties values for a specific peer or
  48  * the default values if
  49  *
  50  * @param cls ignored
  51  * @param address the address
  52  * @return pointer to the values, can be indexed with GNUNET_ATS_PreferenceKind,
  53  * default preferences if peer does not exist
  54  */
  55 const double *
  56 GAS_normalization_get_properties (void *cls,
  57                                   const struct ATS_Address *address);
  58
  59
  60 /**
  61  * Get the normalized preference values for a specific client and peer
  62  *
  63  * @param client client
  64  * @param peer the peer
  65  * @param pref the preference type
  66  * @return the value
  67  */
  68 double
  69 GAS_normalization_get_preferences_by_client (const void *client,
  70                                              const struct GNUNET_PeerIdentity *peer,
  71                                              enum GNUNET_ATS_PreferenceKind pref);
  72
  73 /**
  74  * Normalize an updated preference value
  75  *
  76  * @param client the client with this preference
  77  * @param peer the peer to change the preference for
  78  * @param kind the kind to change the preference
  79  * @param score_abs the normalized score
  80  */
  81 void
  82 GAS_normalization_normalize_preference (void *client,
  83                                         const struct GNUNET_PeerIdentity *peer,
  84                                         enum GNUNET_ATS_PreferenceKind kind,
  85                                         float score_abs);
  86
  87 /**
  88  * Update and normalize a atsi performance information
  89  *
  90  * @param address the address to update
  91  * @param atsi the array of performance information
  92  * @param atsi_count the number of atsi information in the array
  93  */
  94 void
  95 GAS_normalization_normalize_property (struct ATS_Address *address,
  96                                       const struct GNUNET_ATS_Information *atsi,
  97                                       uint32_t atsi_count);
  98
  99
 100 /**
 101  * A performance client disconnected
 102  *
 103  * @param client the disconnecting client
 104  */
 105 void
 106 GAS_normalization_preference_client_disconnect (void *client);
 107
 108
 109 /**
 110  * Start the normalization component
 111  */
 112 void
 113 GAS_normalization_start (void);
 114
 115
 116 /**
 117  * Stop the normalization component and free all items
 118  */
 119 void
 120 GAS_normalization_stop (void);
 121
 122 #endif
 123 /* end of gnunet-service-ats_normalization.h */