src/include/gnunet_nse_service.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 #ifndef GNUNET_NSE_SERVICE_H_
  22 #define GNUNET_NSE_SERVICE_H_
  23
  24 /**
  25  * @file include/gnunet_nse_service.h
  26  * @brief API to retrieve the current network size estimate,
  27  *        also to register for notifications whenever a new
  28  *        network size estimate is calculated.
  29  * @author Nathan Evans
  30  * @defgroup nse network size estimation service
  31  * @{
  32  */
  33
  34 #ifdef __cplusplus
  35 extern "C"
  36 {
  37 #if 0                           /* keep Emacsens' auto-indent happy */
  38 }
  39 #endif
  40 #endif
  41
  42 #include "gnunet_util_lib.h"
  43
  44 /**
  45  * Version of the network size estimation API.
  46  */
  47 #define GNUNET_NSE_VERSION 0x00000000
  48
  49 /**
  50  * Handle for the network size estimation service.
  51  */
  52 struct GNUNET_NSE_Handle;
  53
  54 /**
  55  * Callback to call when network size estimate is updated.
  56  *
  57  * @param cls closure
  58  * @param timestamp time when the estimate was received from the server (or created by the server)
  59  * @param logestimate the log(Base 2) value of the current network size estimate
  60  * @param std_dev standard deviation for the estimate
  61  *
  62  */
  63 typedef void (*GNUNET_NSE_Callback) (void *cls,
  64                                      struct GNUNET_TIME_Absolute timestamp,
  65                                      double logestimate, double std_dev);
  66
  67
  68 /**
  69  * Convert the logarithmic estimated returned to the 'GNUNET_NSE_Callback'
  70  * into an absolute estimate in terms of the number of peers in the network.
  71  *
  72  * @param loge logarithmic estimate
  73  * @return absolute number of peers in the network (estimated)
  74  */
  75 #define GNUNET_NSE_log_estimate_to_n(loge) pow(2.0, (loge))
  76
  77
  78 /**
  79  * Connect to the network size estimation service.
  80  *
  81  * @param cfg the configuration to use
  82  * @param func funtion to call with network size estimate
  83  * @param func_cls closure to pass to @a func
  84  * @return handle to use in #GNUNET_NSE_disconnect to stop NSE from invoking the callbacks
  85  */
  86 struct GNUNET_NSE_Handle *
  87 GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
  88                     GNUNET_NSE_Callback func, void *func_cls);
  89
  90
  91 /**
  92  * Disconnect from network size estimation service
  93  *
  94  * @param h handle to destroy
  95  */
  96 void
  97 GNUNET_NSE_disconnect (struct GNUNET_NSE_Handle *h);
  98
  99
 100 #if 0                           /* keep Emacsens' auto-indent happy */
 101 {
 102 #endif
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 /** @} */ /* end of group nse */
 108
 109 #endif /* GNUNET_NSE_SERVICE_H_ */