src/include/gnunet_statistics_service.h

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2009-2013, 2016 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
  19 /**
  20  * @author Christian Grothoff
  21  *
  22  * @file
  23  * API to create, modify and access statistics.
  24  *
  25  * @defgroup statistics  Statistics service
  26  * Track statistics or provide access to statistics.
  27  *
  28  * Create, modify and access statistics about the operation of GNUnet.
  29  *
  30  * All statistical values must be of type `unsigned long long`.
  31  *
  32  * @see [Documentation](https://gnunet.org/gnunet-statistics-subsystem)
  33  *
  34  * @{
  35  */
  36
  37 #ifndef GNUNET_STATISTICS_SERVICE_H
  38 #define GNUNET_STATISTICS_SERVICE_H
  39
  40 #ifdef __cplusplus
  41 extern "C"
  42 {
  43 #if 0                           /* keep Emacsens' auto-indent happy */
  44 }
  45 #endif
  46 #endif
  47
  48 #include "gnunet_util_lib.h"
  49
  50 /**
  51  * Version of the statistics API.
  52  */
  53 #define GNUNET_STATISTICS_VERSION 0x00000000
  54
  55 /**
  56  * Opaque handle for the statistics service.
  57  */
  58 struct GNUNET_STATISTICS_Handle;
  59
  60 /**
  61  * Callback function to process statistic values.
  62  *
  63  * @param cls closure
  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
  69  */
  70 typedef int
  71 (*GNUNET_STATISTICS_Iterator) (void *cls,
  72                                const char *subsystem,
  73                                const char *name,
  74                                uint64_t value,
  75                                int is_persistent);
  76
  77
  78 /**
  79  * Get handle for the statistics service.
  80  *
  81  * @param subsystem name of subsystem using the service
  82  * @param cfg services configuration in use
  83  * @return handle to use
  84  */
  85 struct GNUNET_STATISTICS_Handle *
  86 GNUNET_STATISTICS_create (const char *subsystem,
  87                           const struct GNUNET_CONFIGURATION_Handle *cfg);
  88
  89
  90 /**
  91  * Destroy a handle (free all state associated with it).
  92  *
  93  * @param h statistics handle to destroy
  94  * @param sync_first set to #GNUNET_YES if pending SET requests should
  95  *        be completed
  96  */
  97 void
  98 GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h,
  99                            int sync_first);
 100
 101
 102 /**
 103  * Watch statistics from the peer (be notified whenever they change).
 104  *
 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
 111  */
 112 int
 113 GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle,
 114                          const char *subsystem,
 115                          const char *name,
 116                          GNUNET_STATISTICS_Iterator proc,
 117                          void *proc_cls);
 118
 119
 120 /**
 121  * Stop watching statistics from the peer.
 122  *
 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)
 129  */
 130 int
 131 GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle,
 132                                 const char *subsystem,
 133                                 const char *name,
 134                                 GNUNET_STATISTICS_Iterator proc,
 135                                 void *proc_cls);
 136
 137
 138 /**
 139  * Continuation called by #GNUNET_STATISTICS_get() functions.
 140  *
 141  * @param cls closure
 142  * @param success #GNUNET_OK if statistics were
 143  *        successfully obtained, #GNUNET_SYSERR if not.
 144  */
 145 typedef void
 146 (*GNUNET_STATISTICS_Callback) (void *cls,
 147                                int success);
 148
 149
 150 /**
 151  * Handle that can be used to cancel a statistics 'get' operation.
 152  */
 153 struct GNUNET_STATISTICS_GetHandle;
 154
 155
 156 /**
 157  * Get statistic from the peer.
 158  *
 159  * @param handle identification of the statistics service
 160  * @param subsystem limit to the specified subsystem, NULL for all subsystems
 161  * @param name name of the statistic value, NULL for all values
 162  * @param cont continuation to call when done (can be NULL)
 163  *        This callback CANNOT destroy the statistics handle in the same call.
 164  * @param proc function to call on each value
 165  * @param cls closure for @a proc and @a cont
 166  * @return NULL on error
 167  */
 168 struct GNUNET_STATISTICS_GetHandle *
 169 GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle,
 170                        const char *subsystem,
 171                        const char *name,
 172                        GNUNET_STATISTICS_Callback cont,
 173                        GNUNET_STATISTICS_Iterator proc,
 174                        void *cls);
 175
 176
 177 /**
 178  * Cancel a #GNUNET_STATISTICS_get request.  Must be called before the 'cont'
 179  * function is called.
 180  *
 181  * @param gh handle of the request to cancel
 182  */
 183 void
 184 GNUNET_STATISTICS_get_cancel (struct GNUNET_STATISTICS_GetHandle *gh);
 185
 186
 187 /**
 188  * Set statistic value for the peer.  Will always use our
 189  * subsystem (the argument used when @a handle was created).
 190  *
 191  * @param handle identification of the statistics service
 192  * @param name name of the statistic value
 193  * @param value new value to set
 194  * @param make_persistent should the value be kept across restarts?
 195  */
 196 void
 197 GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
 198                        const char *name,
 199                        uint64_t value,
 200                        int make_persistent);
 201
 202
 203 /**
 204  * Set statistic value for the peer.  Will always use our
 205  * subsystem (the argument used when @a handle was created).
 206  *
 207  * @param handle identification of the statistics service
 208  * @param name name of the statistic value
 209  * @param delta change in value (added to existing value)
 210  * @param make_persistent should the value be kept across restarts?
 211  */
 212 void
 213 GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
 214                           const char *name,
 215                           int64_t delta,
 216                           int make_persistent);
 217
 218
 219
 220 #if 0                           /* keep Emacsens' auto-indent happy */
 221 {
 222 #endif
 223 #ifdef __cplusplus
 224 }
 225 #endif
 226
 227 /** @} */ /* end of group statistics */
 228
 229 #endif