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 #define DEBUG_NSE GNUNET_NO
  34
  35 #define VERIFY_CRYPTO GNUNET_NO
  36
  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    * The current estimated network size.
  54    */
  55   double size_estimate;
  56
  57   /**
  58    * The standard deviation (rounded down
  59    * to the nearest integer) of size
  60    * estimations.
  61    */
  62   double std_deviation;
  63 };
  64
  65 /**
  66  * Network size estimate reply; sent when "this"
  67  * peer's timer has run out before receiving a
  68  * valid reply from another peer.
  69  */
  70 struct GNUNET_NSE_FloodMessage
  71 {
  72   /**
  73    * Type: GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD
  74    */
  75   struct GNUNET_MessageHeader header;
  76
  77   /**
  78    * Purpose.
  79    */
  80   struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
  81
  82   /**
  83    * Number of matching bits between the hash
  84    * of timestamp and the initiator's public
  85    * key.
  86    */
  87   uint32_t distance;
  88
  89   /**
  90    * The current timestamp value (which all
  91    * peers should agree on).
  92    */
  93   struct GNUNET_TIME_AbsoluteNBO timestamp;
  94
  95   /**
  96    * Public key of the originator.
  97    */
  98   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pkey;
  99
 100   /**
 101    * FIXME: use, document.
 102    */
 103   uint32_t proof_of_work;
 104
 105   /**
 106    * FIXME: use, document.
 107    */
 108   struct GNUNET_CRYPTO_RsaSignature signature;
 109 };
 110
 111 #endif