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 GNUNET_NETWORK_STRUCT_BEGIN
  39
  40 /**
  41  * Network size estimate sent from the service
  42  * to clients.  Contains the current size estimate
  43  * (or 0 if none has been calculated) and the
  44  * standard deviation of known estimates.
  45  *
  46  */
  47 struct GNUNET_NSE_ClientMessage
  48 {
  49   /**
  50    * Type: GNUNET_MESSAGE_TYPE_NSE_ESTIMATE
  51    */
  52   struct GNUNET_MessageHeader header;
  53
  54   /**
  55    * For alignment.
  56    */
  57   uint32_t reserved GNUNET_PACKED;
  58
  59   /**
  60    * Timestamp at which the server received the message.
  61    */
  62   struct GNUNET_TIME_AbsoluteNBO timestamp;
  63
  64   /**
  65    * The current estimated network size.
  66    */
  67   double size_estimate GNUNET_PACKED;
  68
  69   /**
  70    * The standard deviation (rounded down
  71    * to the nearest integer) of size
  72    * estimations.
  73    */
  74   double std_deviation GNUNET_PACKED;
  75 };
  76 GNUNET_NETWORK_STRUCT_END
  77
  78 #endif