aboutsummaryrefslogtreecommitdiff
path: root/src/service/statistics/statistics.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/service/statistics/statistics.h')
-rw-r--r--src/service/statistics/statistics.h149
1 files changed, 149 insertions, 0 deletions
diff --git a/src/service/statistics/statistics.h b/src/service/statistics/statistics.h
new file mode 100644
index 000000000..6eb75cc99
--- /dev/null
+++ b/src/service/statistics/statistics.h
@@ -0,0 +1,149 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2001-2014 GNUnet e.V.
4
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.
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 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/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
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
31GNUNET_NETWORK_STRUCT_BEGIN
32
33/**
34 * Statistics message. Contains how long the system is up
35 * and one value.
36 *
37 * The struct is be followed by the service name and
38 * name of the statistic, both 0-terminated.
39 */
40struct GNUNET_STATISTICS_ReplyMessage
41{
42 /**
43 * Type: GNUNET_MESSAGE_TYPE_STATISTICS_VALUE
44 */
45 struct GNUNET_MessageHeader header;
46
47 /**
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).
52 */
53 uint32_t uid GNUNET_PACKED;
54
55 /**
56 * The value.
57 */
58 uint64_t value GNUNET_PACKED;
59};
60
61/**
62 * Flag for the `struct GNUNET_STATISTICS_ReplyMessage` UID only.
63 * Note that other messages use #GNUNET_STATISTICS_SETFLAG_PERSISTENT.
64 */
65#define GNUNET_STATISTICS_PERSIST_BIT ((uint32_t) (1LLU << 31))
66
67/**
68 * The value being set is an absolute change.
69 */
70#define GNUNET_STATISTICS_SETFLAG_ABSOLUTE 0
71
72/**
73 * The value being set is a relative change.
74 */
75#define GNUNET_STATISTICS_SETFLAG_RELATIVE 1
76
77/**
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`!
82 */
83#define GNUNET_STATISTICS_SETFLAG_PERSISTENT 2
84
85
86/**
87 * Message to set a statistic. Followed
88 * by the subsystem name and the name of
89 * the statistic (each 0-terminated).
90 */
91struct GNUNET_STATISTICS_SetMessage
92{
93 /**
94 * Type: #GNUNET_MESSAGE_TYPE_STATISTICS_SET
95 */
96 struct GNUNET_MessageHeader header;
97
98 /**
99 * 0 for absolute value, 1 for relative value; 2 to make persistent
100 * (see GNUNET_STATISTICS_SETFLAG_*).
101 */
102 uint32_t flags GNUNET_PACKED;
103
104 /**
105 * Value. Note that if this is a relative value, it will
106 * be signed even though the type given here is unsigned.
107 */
108 uint64_t value GNUNET_PACKED;
109};
110
111
112/**
113 * Message transmitted if a watched value changes.
114 */
115struct GNUNET_STATISTICS_WatchValueMessage
116{
117 /**
118 * Type: #GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE
119 */
120 struct GNUNET_MessageHeader header;
121
122 /**
123 * 0 for absolute value, 1 for relative value; 2 to make persistent
124 * (see GNUNET_STATISTICS_SETFLAG_*).
125 */
126 uint32_t flags GNUNET_PACKED;
127
128 /**
129 * Unique watch identification number (watch
130 * requests are enumerated in the order they
131 * are received, the first request having
132 * a wid of zero).
133 */
134 uint32_t wid GNUNET_PACKED;
135
136 /**
137 * Reserved (always 0).
138 */
139 uint32_t reserved GNUNET_PACKED;
140
141 /**
142 * Value. Note that if this is a relative value, it will
143 * be signed even though the type given here is unsigned.
144 */
145 uint64_t value GNUNET_PACKED;
146};
147GNUNET_NETWORK_STRUCT_END
148
149#endif