src/include/gnunet_statistics_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2009, 2010 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
  33 extern "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  */
  52 struct 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  */
  64 typedef int (*GNUNET_STATISTICS_Iterator) (void *cls,
  65                                            const char *subsystem,
  66                                            const char *name,
  67                                            uint64_t value, int is_persistent);
  68
  69 /**
  70  * Get handle for the statistics service.
  71  *
  72  * @param subsystem name of subsystem using the service
  73  * @param cfg services configuration in use
  74  * @return handle to use
  75  */
  76 struct GNUNET_STATISTICS_Handle
  77     *GNUNET_STATISTICS_create (const char *subsystem,
  78                                const struct GNUNET_CONFIGURATION_Handle *cfg);
  79
  80
  81 /**
  82  * Destroy a handle (free all state associated with
  83  * it).
  84  *
  85  * @param h statistics handle to destroy
  86  * @param sync_first set to GNUNET_YES if pending SET requests should
  87  *        be completed
  88  */
  89 void GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h,
  90                                 int sync_first);
  91
  92
  93 /**
  94  * Watch statistics from the peer (be notified whenever they change).
  95  * Note that the only way to cancel a "watch" request is to destroy
  96  * the statistics handle given as the first argument to this call.
  97  *
  98  * @param handle identification of the statistics service
  99  * @param subsystem limit to the specified subsystem, never NULL
 100  * @param name name of the statistic value, never NULL
 101  * @param proc function to call on each value
 102  * @param proc_cls closure for proc
 103  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 104  */
 105 int
 106 GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle,
 107                          const char *subsystem,
 108                          const char *name,
 109                          GNUNET_STATISTICS_Iterator proc, void *proc_cls);
 110
 111
 112 /**
 113  * Continuation called by the "get_all" and "get" functions.
 114  *
 115  * @param cls closure
 116  * @param success GNUNET_OK if statistics were
 117  *        successfully obtained, GNUNET_SYSERR if not.
 118  */
 119 typedef void (*GNUNET_STATISTICS_Callback) (void *cls, int success);
 120
 121 /**
 122  * Handle that can be used to cancel a statistics 'get' operation.
 123  */
 124 struct GNUNET_STATISTICS_GetHandle;
 125
 126 /**
 127  * Get statistic from the peer.
 128  *
 129  * @param handle identification of the statistics service
 130  * @param subsystem limit to the specified subsystem, NULL for our subsystem
 131  * @param name name of the statistic value, NULL for all values
 132  * @param timeout after how long should we give up (and call
 133  *        notify with buf NULL and size 0)?
 134  * @param cont continuation to call when done (can be NULL)
 135  * @param proc function to call on each value
 136  * @param cls closure for proc and cont
 137  * @return NULL on error
 138  */
 139 struct GNUNET_STATISTICS_GetHandle *GNUNET_STATISTICS_get (struct
 140                                                            GNUNET_STATISTICS_Handle
 141                                                            *handle,
 142                                                            const char
 143                                                            *subsystem,
 144                                                            const char *name,
 145                                                            struct
 146                                                            GNUNET_TIME_Relative
 147                                                            timeout,
 148                                                            GNUNET_STATISTICS_Callback
 149                                                            cont,
 150                                                            GNUNET_STATISTICS_Iterator
 151                                                            proc, void *cls);
 152
 153
 154 /**
 155  * Cancel a 'get' request.  Must be called before the 'cont'
 156  * function is called.
 157  *
 158  * @param gh handle of the request to cancel
 159  */
 160 void GNUNET_STATISTICS_get_cancel (struct GNUNET_STATISTICS_GetHandle *gh);
 161
 162
 163 /**
 164  * Set statistic value for the peer.  Will always use our
 165  * subsystem (the argument used when "handle" was created).
 166  *
 167  * @param handle identification of the statistics service
 168  * @param name name of the statistic value
 169  * @param value new value to set
 170  * @param make_persistent should the value be kept across restarts?
 171  */
 172 void
 173 GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
 174                        const char *name, uint64_t value, int make_persistent);
 175
 176 /**
 177  * Set statistic value for the peer.  Will always use our
 178  * subsystem (the argument used when "handle" was created).
 179  *
 180  * @param handle identification of the statistics service
 181  * @param name name of the statistic value
 182  * @param delta change in value (added to existing value)
 183  * @param make_persistent should the value be kept across restarts?
 184  */
 185 void
 186 GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
 187                           const char *name, int64_t delta, int make_persistent);
 188
 189
 190
 191 #if 0                           /* keep Emacsens' auto-indent happy */
 192 {
 193 #endif
 194 #ifdef __cplusplus
 195 }
 196 #endif
 197
 198 #endif