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 it
6 under the terms of the GNU Affero 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.
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.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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;
62 * Flag for the `struct GNUNET_STATISTICS_ReplyMessage` UID only.
63 * Note that other messages use #GNUNET_STATISTICS_SETFLAG_PERSISTENT.
65 #define GNUNET_STATISTICS_PERSIST_BIT ((uint32_t) (1LLU << 31))
68 * The value being set is an absolute change.
70 #define GNUNET_STATISTICS_SETFLAG_ABSOLUTE 0
73 * The value being set is a relative change.
75 #define GNUNET_STATISTICS_SETFLAG_RELATIVE 1
78 * The value being set is to be persistent (note that
79 * this bit can be combined with #GNUNET_STATISTICS_SETFLAG_RELATIVE).
80 * This value must not be used for the `uid` member of
81 * `struct GNUNET_STATISTICS_ReplyMessage`!
83 #define GNUNET_STATISTICS_SETFLAG_PERSISTENT 2
87 * Message to set a statistic. Followed
88 * by the subsystem name and the name of
89 * the statistic (each 0-terminated).
91 struct GNUNET_STATISTICS_SetMessage
94 * Type: #GNUNET_MESSAGE_TYPE_STATISTICS_SET
96 struct GNUNET_MessageHeader header;
99 * 0 for absolute value, 1 for relative value; 2 to make persistent
100 * (see GNUNET_STATISTICS_SETFLAG_*).
102 uint32_t flags GNUNET_PACKED;
105 * Value. Note that if this is a relative value, it will
106 * be signed even though the type given here is unsigned.
108 uint64_t value GNUNET_PACKED;
113 * Message transmitted if a watched value changes.
115 struct GNUNET_STATISTICS_WatchValueMessage
118 * Type: #GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE
120 struct GNUNET_MessageHeader header;
123 * 0 for absolute value, 1 for relative value; 2 to make persistent
124 * (see GNUNET_STATISTICS_SETFLAG_*).
126 uint32_t flags GNUNET_PACKED;
129 * Unique watch identification number (watch
130 * requests are enumerated in the order they
131 * are received, the first request having
134 uint32_t wid GNUNET_PACKED;
137 * Reserved (always 0).
139 uint32_t reserved GNUNET_PACKED;
142 * Value. Note that if this is a relative value, it will
143 * be signed even though the type given here is unsigned.
145 uint64_t value GNUNET_PACKED;
147 GNUNET_NETWORK_STRUCT_END