src/nse/nse.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001-2011 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14 */
  15
  16 /**
  17  * @author Nathan Evans
  18  * @file nse/nse.h
  19  *
  20  * @brief Common type definitions for the network size estimation
  21  *        service and API.
  22  */
  23 #ifndef NSE_H
  24 #define NSE_H
  25
  26 #include "gnunet_common.h"
  27
  28 GNUNET_NETWORK_STRUCT_BEGIN
  29
  30 /**
  31  * Network size estimate sent from the service
  32  * to clients.  Contains the current size estimate
  33  * (or 0 if none has been calculated) and the
  34  * standard deviation of known estimates.
  35  *
  36  */
  37 struct GNUNET_NSE_ClientMessage
  38 {
  39   /**
  40    * Type: GNUNET_MESSAGE_TYPE_NSE_ESTIMATE
  41    */
  42   struct GNUNET_MessageHeader header;
  43
  44   /**
  45    * For alignment.
  46    */
  47   uint32_t reserved GNUNET_PACKED;
  48
  49   /**
  50    * Timestamp at which the server received the message.
  51    */
  52   struct GNUNET_TIME_AbsoluteNBO timestamp;
  53
  54   /**
  55    * The current estimated network size.
  56    */
  57   double size_estimate GNUNET_PACKED;
  58
  59   /**
  60    * The standard deviation (rounded down
  61    * to the nearest integer) of size
  62    * estimations.
  63    */
  64   double std_deviation GNUNET_PACKED;
  65 };
  66 GNUNET_NETWORK_STRUCT_END
  67
  68 #endif