src/nse/nse.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-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 2, 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  * @author Nathan Evans
  23  * @file nse/nse.h
  24  *
  25  * @brief Common type definitions for the network size estimation
  26  *        service and API.
  27  */
  28 #ifndef NSE_H
  29 #define NSE_H
  30
  31 #include "gnunet_common.h"
  32
  33 /**
  34  * Generate debug-level log messages?
  35  */
  36 #define DEBUG_NSE GNUNET_EXTRA_LOGGING
  37
  38 /**
  39  * Network size estimate sent from the service
  40  * to clients.  Contains the current size estimate
  41  * (or 0 if none has been calculated) and the
  42  * standard deviation of known estimates.
  43  *
  44  */
  45 struct GNUNET_NSE_ClientMessage
  46 {
  47   /**
  48    * Type: GNUNET_MESSAGE_TYPE_NSE_UPDATE
  49    */
  50   struct GNUNET_MessageHeader header;
  51
  52   /**
  53    * For alignment.
  54    */
  55   uint32_t reserved GNUNET_PACKED;
  56
  57   /**
  58    * Timestamp at which the server received the message.
  59    */
  60   struct GNUNET_TIME_AbsoluteNBO timestamp;
  61
  62   /**
  63    * The current estimated network size.
  64    */
  65   double size_estimate GNUNET_PACKED;
  66
  67   /**
  68    * The standard deviation (rounded down
  69    * to the nearest integer) of size
  70    * estimations.
  71    */
  72   double std_deviation GNUNET_PACKED;
  73 };
  74
  75
  76 #endif