2 This file is part of GNUnet
3 (C) 2009-2013 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
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 * @defgroup statistics track statistics or provide access to statistics
31 #ifndef GNUNET_STATISTICS_SERVICE_H
32 #define GNUNET_STATISTICS_SERVICE_H
37 #if 0 /* keep Emacsens' auto-indent happy */
42 #include "gnunet_util_lib.h"
45 * Version of the statistics API.
47 #define GNUNET_STATISTICS_VERSION 0x00000000
50 * Opaque handle for the statistics service.
52 struct GNUNET_STATISTICS_Handle;
55 * Callback function to process statistic values.
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
64 typedef int (*GNUNET_STATISTICS_Iterator) (void *cls, const char *subsystem,
65 const char *name, uint64_t value,
69 * Get handle for the statistics service.
71 * @param subsystem name of subsystem using the service
72 * @param cfg services configuration in use
73 * @return handle to use
75 struct GNUNET_STATISTICS_Handle *
76 GNUNET_STATISTICS_create (const char *subsystem,
77 const struct GNUNET_CONFIGURATION_Handle *cfg);
81 * Destroy a handle (free all state associated with
84 * @param h statistics handle to destroy
85 * @param sync_first set to #GNUNET_YES if pending SET requests should
89 GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h, int sync_first);
93 * Watch statistics from the peer (be notified whenever they change).
95 * @param handle identification of the statistics service
96 * @param subsystem limit to the specified subsystem, never NULL
97 * @param name name of the statistic value, never NULL
98 * @param proc function to call on each value
99 * @param proc_cls closure for @a proc
100 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
103 GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle,
104 const char *subsystem, const char *name,
105 GNUNET_STATISTICS_Iterator proc, void *proc_cls);
109 * Stop watching statistics from the peer.
111 * @param handle identification of the statistics service
112 * @param subsystem limit to the specified subsystem, never NULL
113 * @param name name of the statistic value, never NULL
114 * @param proc function to call on each value
115 * @param proc_cls closure for @a proc
116 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error (no such watch)
119 GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle,
120 const char *subsystem, const char *name,
121 GNUNET_STATISTICS_Iterator proc, void *proc_cls);
125 * Continuation called by #GNUNET_STATISTICS_get functions.
128 * @param success #GNUNET_OK if statistics were
129 * successfully obtained, #GNUNET_SYSERR if not.
131 typedef void (*GNUNET_STATISTICS_Callback) (void *cls, int success);
135 * Handle that can be used to cancel a statistics 'get' operation.
137 struct GNUNET_STATISTICS_GetHandle;
141 * Get statistic from the peer.
143 * @param handle identification of the statistics service
144 * @param subsystem limit to the specified subsystem, NULL for all subsystems
145 * @param name name of the statistic value, NULL for all values
146 * @param timeout after how long should we give up (and call
147 * notify with buf NULL and size 0)?
148 * @param cont continuation to call when done (can be NULL)
149 * This callback CANNOT destroy the statistics handle in the same call.
150 * @param proc function to call on each value
151 * @param cls closure for @a proc and @a cont
152 * @return NULL on error
154 struct GNUNET_STATISTICS_GetHandle *
155 GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle,
156 const char *subsystem, const char *name,
157 struct GNUNET_TIME_Relative timeout,
158 GNUNET_STATISTICS_Callback cont,
159 GNUNET_STATISTICS_Iterator proc, void *cls);
163 * Cancel a #GNUNET_STATISTICS_get request. Must be called before the 'cont'
164 * function is called.
166 * @param gh handle of the request to cancel
169 GNUNET_STATISTICS_get_cancel (struct GNUNET_STATISTICS_GetHandle *gh);
173 * Set statistic value for the peer. Will always use our
174 * subsystem (the argument used when @a handle was created).
176 * @param handle identification of the statistics service
177 * @param name name of the statistic value
178 * @param value new value to set
179 * @param make_persistent should the value be kept across restarts?
182 GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
183 const char *name, uint64_t value, int make_persistent);
187 * Set statistic value for the peer. Will always use our
188 * subsystem (the argument used when @a handle was created).
190 * @param handle identification of the statistics service
191 * @param name name of the statistic value
192 * @param delta change in value (added to existing value)
193 * @param make_persistent should the value be kept across restarts?
196 GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
197 const char *name, int64_t delta, int make_persistent);
201 #if 0 /* keep Emacsens' auto-indent happy */
208 /** @} */ /* end of group statistics */