2 This file is part of GNUnet
3 Copyright (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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @author Christian Grothoff
25 * API to create, modify and access statistics.
27 * @defgroup statistics Statistics service
28 * Track statistics or provide access to statistics.
30 * Create, modify and access statistics about the operation of GNUnet.
32 * All statistical values must be of type `unsigned long long`.
37 #ifndef GNUNET_STATISTICS_SERVICE_H
38 #define GNUNET_STATISTICS_SERVICE_H
43 #if 0 /* keep Emacsens' auto-indent happy */
48 #include "gnunet_util_lib.h"
51 * Version of the statistics API.
53 #define GNUNET_STATISTICS_VERSION 0x00000000
56 * Opaque handle for the statistics service.
58 struct GNUNET_STATISTICS_Handle;
61 * Callback function to process statistic values.
64 * @param subsystem name of subsystem that created the statistic
65 * @param name the name of the datum
66 * @param value the current value
67 * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
68 * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
71 (*GNUNET_STATISTICS_Iterator) (void *cls,
72 const char *subsystem,
79 * Get handle for the statistics service.
81 * @param subsystem name of subsystem using the service
82 * @param cfg services configuration in use
83 * @return handle to use
85 struct GNUNET_STATISTICS_Handle *
86 GNUNET_STATISTICS_create (const char *subsystem,
87 const struct GNUNET_CONFIGURATION_Handle *cfg);
91 * Destroy a handle (free all state associated with it).
93 * @param h statistics handle to destroy
94 * @param sync_first set to #GNUNET_YES if pending SET requests should
98 GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h,
103 * Watch statistics from the peer (be notified whenever they change).
105 * @param handle identification of the statistics service
106 * @param subsystem limit to the specified subsystem, never NULL
107 * @param name name of the statistic value, never NULL
108 * @param proc function to call on each value
109 * @param proc_cls closure for @a proc
110 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
113 GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle,
114 const char *subsystem,
116 GNUNET_STATISTICS_Iterator proc,
121 * Stop watching statistics from the peer.
123 * @param handle identification of the statistics service
124 * @param subsystem limit to the specified subsystem, never NULL
125 * @param name name of the statistic value, never NULL
126 * @param proc function to call on each value
127 * @param proc_cls closure for @a proc
128 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error (no such watch)
131 GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle,
132 const char *subsystem,
134 GNUNET_STATISTICS_Iterator proc,
139 * Continuation called by #GNUNET_STATISTICS_get functions.
142 * @param success #GNUNET_OK if statistics were
143 * successfully obtained, #GNUNET_SYSERR if not.
145 typedef void (*GNUNET_STATISTICS_Callback) (void *cls,
150 * Handle that can be used to cancel a statistics 'get' operation.
152 struct GNUNET_STATISTICS_GetHandle;
156 * Get statistic from the peer.
158 * @param handle identification of the statistics service
159 * @param subsystem limit to the specified subsystem, NULL for all subsystems
160 * @param name name of the statistic value, NULL for all values
161 * @param timeout after how long should we give up (and call
162 * notify with buf NULL and size 0)?
163 * @param cont continuation to call when done (can be NULL)
164 * This callback CANNOT destroy the statistics handle in the same call.
165 * @param proc function to call on each value
166 * @param cls closure for @a proc and @a cont
167 * @return NULL on error
169 struct GNUNET_STATISTICS_GetHandle *
170 GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle,
171 const char *subsystem,
173 struct GNUNET_TIME_Relative timeout,
174 GNUNET_STATISTICS_Callback cont,
175 GNUNET_STATISTICS_Iterator proc, void *cls);
179 * Cancel a #GNUNET_STATISTICS_get request. Must be called before the 'cont'
180 * function is called.
182 * @param gh handle of the request to cancel
185 GNUNET_STATISTICS_get_cancel (struct GNUNET_STATISTICS_GetHandle *gh);
189 * Set statistic value for the peer. Will always use our
190 * subsystem (the argument used when @a handle was created).
192 * @param handle identification of the statistics service
193 * @param name name of the statistic value
194 * @param value new value to set
195 * @param make_persistent should the value be kept across restarts?
198 GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
201 int make_persistent);
205 * Set statistic value for the peer. Will always use our
206 * subsystem (the argument used when @a handle was created).
208 * @param handle identification of the statistics service
209 * @param name name of the statistic value
210 * @param delta change in value (added to existing value)
211 * @param make_persistent should the value be kept across restarts?
214 GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
217 int make_persistent);
221 #if 0 /* keep Emacsens' auto-indent happy */
228 /** @} */ /* end of group statistics */