src/ats/gnunet-service-ats_normalization.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (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 /**
  32  * Value we return for a normalized quality score if we have no data.
  33  */
  34 #define DEFAULT_REL_QUALITY 1.0
  35
  36
  37 /**
  38  * Get the normalized properties values for a specific peer or
  39  * the default values if no normalized values are available.
  40  *
  41  * @param cls ignored
  42  * @param address the address
  43  * @return pointer to the values, can be indexed with GNUNET_ATS_PreferenceKind
  44  */
  45 const double *
  46 GAS_normalization_get_properties (void *cls,
  47                                   const struct ATS_Address *address);
  48
  49
  50 /**
  51  * Update and normalize a @a atsi performance information
  52  *
  53  * @param address the address to update
  54  * @param atsi the array of performance information
  55  * @param atsi_count the number of atsi information in the array
  56  */
  57 void
  58 GAS_normalization_normalize_property (struct ATS_Address *address,
  59                                       const struct GNUNET_ATS_Information *atsi,
  60                                       uint32_t atsi_count);
  61
  62
  63 /**
  64  * Start the normalization component
  65  */
  66 void
  67 GAS_normalization_start (void);
  68
  69
  70 /**
  71  * Stop the normalization component and free all items
  72  */
  73 void
  74 GAS_normalization_stop (void);
  75
  76 #endif
  77 /* end of gnunet-service-ats_normalization.h */