src/statistics/statistics.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2009 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 Christian Grothoff
  23  * @file statistics/statistics.h
  24  */
  25 #ifndef STATISTICS_H
  26 #define STATISTICS_H
  27
  28 #include "gnunet_common.h"
  29
  30 #define DEBUG_STATISTICS GNUNET_EXTRA_LOGGING
  31
  32 GNUNET_NETWORK_STRUCT_BEGIN
  33
  34 /**
  35  * Statistics message. Contains how long the system is up
  36  * and one value.
  37  *
  38  * The struct is be followed by the service name and
  39  * name of the statistic, both 0-terminated.
  40  */
  41 struct GNUNET_STATISTICS_ReplyMessage
  42 {
  43   /**
  44    * Type:  GNUNET_MESSAGE_TYPE_STATISTICS_VALUE
  45    */
  46   struct GNUNET_MessageHeader header;
  47
  48   /**
  49    * Unique numerical identifier for the value (will
  50    * not change during the same client-session).  Highest
  51    * bit will be set for persistent values.
  52    */
  53   uint32_t uid GNUNET_PACKED;
  54
  55   /**
  56    * The value.
  57    */
  58   uint64_t value GNUNET_PACKED;
  59
  60 };
  61
  62 #define GNUNET_STATISTICS_PERSIST_BIT (1<<31)
  63
  64 #define GNUNET_STATISTICS_SETFLAG_ABSOLUTE 0
  65
  66 #define GNUNET_STATISTICS_SETFLAG_RELATIVE 1
  67
  68 #define GNUNET_STATISTICS_SETFLAG_PERSISTENT 2
  69
  70 /**
  71  * Message to set a statistic.  Followed
  72  * by the subsystem name and the name of
  73  * the statistic (each 0-terminated).
  74  */
  75 struct GNUNET_STATISTICS_SetMessage
  76 {
  77   /**
  78    * Type: GNUNET_MESSAGE_TYPE_STATISTICS_SET
  79    */
  80   struct GNUNET_MessageHeader header;
  81
  82   /**
  83    * 0 for absolute value, 1 for relative value; 2 to make persistent
  84    * (see GNUNET_STATISTICS_SETFLAG_*).
  85    */
  86   uint32_t flags GNUNET_PACKED;
  87
  88   /**
  89    * Value. Note that if this is a relative value, it will
  90    * be signed even though the type given here is unsigned.
  91    */
  92   uint64_t value GNUNET_PACKED;
  93
  94 };
  95
  96
  97 /**
  98  * Message transmitted if a watched value changes.
  99  */
 100 struct GNUNET_STATISTICS_WatchValueMessage
 101 {
 102   /**
 103    * Type: GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE
 104    */
 105   struct GNUNET_MessageHeader header;
 106
 107   /**
 108    * 0 for absolute value, 1 for relative value; 2 to make persistent
 109    * (see GNUNET_STATISTICS_SETFLAG_*).
 110    */
 111   uint32_t flags GNUNET_PACKED;
 112
 113   /**
 114    * Unique watch identification number (watch
 115    * requests are enumerated in the order they
 116    * are received, the first request having
 117    * a wid of zero).
 118    */
 119   uint32_t wid GNUNET_PACKED;
 120
 121   /**
 122    * Reserved (always 0).
 123    */
 124   uint32_t reserved GNUNET_PACKED;
 125
 126   /**
 127    * Value. Note that if this is a relative value, it will
 128    * be signed even though the type given here is unsigned.
 129    */
 130   uint64_t value GNUNET_PACKED;
 131
 132 };
 133 GNUNET_NETWORK_STRUCT_END
 134
 135 #endif