aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_statistics_service.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_statistics_service.h')
-rw-r--r--src/include/gnunet_statistics_service.h157
1 files changed, 157 insertions, 0 deletions
diff --git a/src/include/gnunet_statistics_service.h b/src/include/gnunet_statistics_service.h
new file mode 100644
index 000000000..8dd11094c
--- /dev/null
+++ b/src/include/gnunet_statistics_service.h
@@ -0,0 +1,157 @@
1/*
2 This file is part of GNUnet
3 (C) 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 * @file include/gnunet_statistics_service.h
23 * @brief API to create, modify and access statistics about
24 * the operation of GNUnet; all statistical values
25 * must be of type "unsigned long long".
26 * @author Christian Grothoff
27 */
28
29#ifndef GNUNET_STATISTICS_SERVICE_H
30#define GNUNET_STATISTICS_SERVICE_H
31
32#ifdef __cplusplus
33extern "C"
34{
35#if 0 /* keep Emacsens' auto-indent happy */
36}
37#endif
38#endif
39
40#include "gnunet_common.h"
41#include "gnunet_configuration_lib.h"
42#include "gnunet_scheduler_lib.h"
43
44/**
45 * Version of the statistics API.
46 */
47#define GNUNET_STATISTICS_VERSION 0x00000000
48
49/**
50 * Opaque handle for the statistics service.
51 */
52struct GNUNET_STATISTICS_Handle;
53
54/**
55 * Callback function to process statistic values.
56 *
57 * @param cls closure
58 * @param subsystem name of subsystem that created the statistic
59 * @param name the name of the datum
60 * @param value the current value
61 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
62 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
63 */
64typedef int (*GNUNET_STATISTICS_Iterator) (void *cls,
65 const char *subsystem,
66 const char *name,
67 unsigned long long value,
68 int is_persistent);
69
70/**
71 * Get handle for the statistics service.
72 *
73 * @param sched scheduler to use
74 * @param subsystem name of subsystem using the service
75 * @param cfg services configuration in use
76 * @return handle to use
77 */
78struct GNUNET_STATISTICS_Handle
79 *GNUNET_STATISTICS_create (struct GNUNET_SCHEDULER_Handle *sched,
80 const char *subsystem,
81 struct GNUNET_CONFIGURATION_Handle *cfg);
82
83
84/**
85 * Destroy a handle (free all state associated with
86 * it).
87 */
88void GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *handle);
89
90
91/**
92 * Continuation called by the "get_all" and "get" functions.
93 *
94 * @param cls closure
95 * @param success GNUNET_OK if statistics were
96 * successfully obtained, GNUNET_SYSERR if not.
97 */
98typedef void (*GNUNET_STATISTICS_Callback) (void *cls, int success);
99
100/**
101 * Get statistic from the peer.
102 *
103 * @param handle identification of the statistics service
104 * @param subsystem limit to the specified subsystem, NULL for our subsystem
105 * @param name name of the statistic value, NULL for all values
106 * @param timeout after how long should we give up (and call
107 * notify with buf NULL and size 0)?
108 * @param cont continuation to call when done (can be NULL)
109 * @param proc function to call on each value
110 * @param cls closure for proc and cont
111 */
112void
113GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle,
114 const char *subsystem,
115 const char *name,
116 struct GNUNET_TIME_Relative timeout,
117 GNUNET_STATISTICS_Callback cont,
118 GNUNET_STATISTICS_Iterator proc, void *cls);
119
120/**
121 * Set statistic value for the peer. Will always use our
122 * subsystem (the argument used when "handle" was created).
123 *
124 * @param handle identification of the statistics service
125 * @param name name of the statistic value
126 * @param value new value to set
127 * @param make_persistent should the value be kept across restarts?
128 */
129void
130GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
131 const char *name,
132 unsigned long long value, int make_persistent);
133
134/**
135 * Set statistic value for the peer. Will always use our
136 * subsystem (the argument used when "handle" was created).
137 *
138 * @param handle identification of the statistics service
139 * @param name name of the statistic value
140 * @param delta change in value (added to existing value)
141 * @param make_persistent should the value be kept across restarts?
142 */
143void
144GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
145 const char *name,
146 long long delta, int make_persistent);
147
148
149
150#if 0 /* keep Emacsens' auto-indent happy */
151{
152#endif
153#ifdef __cplusplus
154}
155#endif
156
157#endif