X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_statistics_service.h;h=94fa49358a44cc62ae6cd2ce95c691d2a0a07e01;hb=0d4f151374efb1972361c40b6624bf4fd0e3fcaa;hp=75c7bd18a1ff300967f063e5e17275e44c9d23f9;hpb=b94abb8ad0d6644e8f1a03706e0a590c0c69dd91;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_statistics_service.h b/src/include/gnunet_statistics_service.h index 75c7bd18a..94fa49358 100644 --- a/src/include/gnunet_statistics_service.h +++ b/src/include/gnunet_statistics_service.h @@ -1,30 +1,38 @@ /* This file is part of GNUnet - (C) 2009-2013 Christian Grothoff (and other contributing authors) + Copyright (C) 2009-2013, 2016 GNUnet e.V. - GNUnet is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 3, or (at your - option) any later version. + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . - You should have received a copy of the GNU General Public License - along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + SPDX-License-Identifier: AGPL3.0-or-later */ /** - * @file include/gnunet_statistics_service.h - * @brief API to create, modify and access statistics about - * the operation of GNUnet; all statistical values - * must be of type `unsigned long long`. * @author Christian Grothoff - * @defgroup statistics track statistics or provide access to statistics + * + * @file + * API to create, modify and access statistics. + * + * @defgroup statistics Statistics service + * Track statistics or provide access to statistics. + * + * Create, modify and access statistics about the operation of GNUnet. + * + * All statistical values must be of type `unsigned long long`. + * + * @see [Documentation](https://gnunet.org/gnunet-statistics-subsystem) + * * @{ */ @@ -39,9 +47,7 @@ extern "C" #endif #endif -#include "gnunet_common.h" -#include "gnunet_configuration_lib.h" -#include "gnunet_scheduler_lib.h" +#include "gnunet_util_lib.h" /** * Version of the statistics API. @@ -63,9 +69,13 @@ struct GNUNET_STATISTICS_Handle; * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration */ -typedef int (*GNUNET_STATISTICS_Iterator) (void *cls, const char *subsystem, - const char *name, uint64_t value, - int is_persistent); +typedef int +(*GNUNET_STATISTICS_Iterator) (void *cls, + const char *subsystem, + const char *name, + uint64_t value, + int is_persistent); + /** * Get handle for the statistics service. @@ -80,15 +90,15 @@ GNUNET_STATISTICS_create (const char *subsystem, /** - * Destroy a handle (free all state associated with - * it). + * Destroy a handle (free all state associated with it). * * @param h statistics handle to destroy * @param sync_first set to #GNUNET_YES if pending SET requests should * be completed */ void -GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h, int sync_first); +GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h, + int sync_first); /** @@ -103,8 +113,10 @@ GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h, int sync_first); */ int GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle, - const char *subsystem, const char *name, - GNUNET_STATISTICS_Iterator proc, void *proc_cls); + const char *subsystem, + const char *name, + GNUNET_STATISTICS_Iterator proc, + void *proc_cls); /** @@ -119,18 +131,22 @@ GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle, */ int GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle, - const char *subsystem, const char *name, - GNUNET_STATISTICS_Iterator proc, void *proc_cls); + const char *subsystem, + const char *name, + GNUNET_STATISTICS_Iterator proc, + void *proc_cls); /** - * Continuation called by #GNUNET_STATISTICS_get functions. + * Continuation called by #GNUNET_STATISTICS_get() functions. * * @param cls closure * @param success #GNUNET_OK if statistics were * successfully obtained, #GNUNET_SYSERR if not. */ -typedef void (*GNUNET_STATISTICS_Callback) (void *cls, int success); +typedef void +(*GNUNET_STATISTICS_Callback) (void *cls, + int success); /** @@ -145,8 +161,6 @@ struct GNUNET_STATISTICS_GetHandle; * @param handle identification of the statistics service * @param subsystem limit to the specified subsystem, NULL for all subsystems * @param name name of the statistic value, NULL for all values - * @param timeout after how long should we give up (and call - * notify with buf NULL and size 0)? * @param cont continuation to call when done (can be NULL) * This callback CANNOT destroy the statistics handle in the same call. * @param proc function to call on each value @@ -155,10 +169,11 @@ struct GNUNET_STATISTICS_GetHandle; */ struct GNUNET_STATISTICS_GetHandle * GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle, - const char *subsystem, const char *name, - struct GNUNET_TIME_Relative timeout, + const char *subsystem, + const char *name, GNUNET_STATISTICS_Callback cont, - GNUNET_STATISTICS_Iterator proc, void *cls); + GNUNET_STATISTICS_Iterator proc, + void *cls); /** @@ -182,7 +197,9 @@ GNUNET_STATISTICS_get_cancel (struct GNUNET_STATISTICS_GetHandle *gh); */ void GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle, - const char *name, uint64_t value, int make_persistent); + const char *name, + uint64_t value, + int make_persistent); /** @@ -196,7 +213,9 @@ GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle, */ void GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle, - const char *name, int64_t delta, int make_persistent); + const char *name, + int64_t delta, + int make_persistent);