2 This file is part of GNUnet.
3 Copyright (C) 2001-2014 GNUnet e.V.
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 3, or (at your
8 option) any later version.
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.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @author Christian Grothoff
23 * @file statistics/statistics.h
28 #include "gnunet_common.h"
31 GNUNET_NETWORK_STRUCT_BEGIN
34 * Statistics message. Contains how long the system is up
37 * The struct is be followed by the service name and
38 * name of the statistic, both 0-terminated.
40 struct GNUNET_STATISTICS_ReplyMessage
43 * Type: GNUNET_MESSAGE_TYPE_STATISTICS_VALUE
45 struct GNUNET_MessageHeader header;
48 * Unique numerical identifier for the value (will
49 * not change during the same client-session). Highest
50 * bit will be set for persistent values (see
51 * #GNUNET_STATISTICS_PERSIST_BIT).
53 uint32_t uid GNUNET_PACKED;
58 uint64_t value GNUNET_PACKED;
63 * Flag for the `struct GNUNET_STATISTICS_ReplyMessage` UID only.
64 * Note that other messages use #GNUNET_STATISTICS_SETFLAG_PERSISTENT.
66 #define GNUNET_STATISTICS_PERSIST_BIT ((uint32_t) (1LLU<<31))
69 * The value being set is an absolute change.
71 #define GNUNET_STATISTICS_SETFLAG_ABSOLUTE 0
74 * The value being set is a relative change.
76 #define GNUNET_STATISTICS_SETFLAG_RELATIVE 1
79 * The value being set is to be persistent (note that
80 * this bit can be combined with #GNUNET_STATISTICS_SETFLAG_RELATIVE).
81 * This value must not be used for the `uid` member of
82 * `struct GNUNET_STATISTICS_ReplyMessage`!
84 #define GNUNET_STATISTICS_SETFLAG_PERSISTENT 2
88 * Message to set a statistic. Followed
89 * by the subsystem name and the name of
90 * the statistic (each 0-terminated).
92 struct GNUNET_STATISTICS_SetMessage
95 * Type: #GNUNET_MESSAGE_TYPE_STATISTICS_SET
97 struct GNUNET_MessageHeader header;
100 * 0 for absolute value, 1 for relative value; 2 to make persistent
101 * (see GNUNET_STATISTICS_SETFLAG_*).
103 uint32_t flags GNUNET_PACKED;
106 * Value. Note that if this is a relative value, it will
107 * be signed even though the type given here is unsigned.
109 uint64_t value GNUNET_PACKED;
115 * Message transmitted if a watched value changes.
117 struct GNUNET_STATISTICS_WatchValueMessage
120 * Type: #GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE
122 struct GNUNET_MessageHeader header;
125 * 0 for absolute value, 1 for relative value; 2 to make persistent
126 * (see GNUNET_STATISTICS_SETFLAG_*).
128 uint32_t flags GNUNET_PACKED;
131 * Unique watch identification number (watch
132 * requests are enumerated in the order they
133 * are received, the first request having
136 uint32_t wid GNUNET_PACKED;
139 * Reserved (always 0).
141 uint32_t reserved GNUNET_PACKED;
144 * Value. Note that if this is a relative value, it will
145 * be signed even though the type given here is unsigned.
147 uint64_t value GNUNET_PACKED;
150 GNUNET_NETWORK_STRUCT_END