X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_nse_service.h;h=90f74a7ffbc65f995f66766b67b6564434d806f9;hb=4e084e4842cddf5de988534c84e2d65bb122472f;hp=9169c68ba8d0eb21ac6a4a775f771de6ce06d94e;hpb=5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_nse_service.h b/src/include/gnunet_nse_service.h index 9169c68ba..90f74a7ff 100644 --- a/src/include/gnunet_nse_service.h +++ b/src/include/gnunet_nse_service.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet - (C) 2011 Christian Grothoff (and other contributing authors) + Copyright (C) 2011 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 @@ -14,20 +14,28 @@ 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. + Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. */ #ifndef GNUNET_NSE_SERVICE_H_ #define GNUNET_NSE_SERVICE_H_ /** - * @file include/gnunet_nse_service.h - * @brief API to retrieve the current network size estimate, - * also to register for notifications whenever a new - * network size estimate is calculated. * @author Nathan Evans - * @defgroup nse network size estimation service + * + * @file + * API to retrieve the current network size estimate + * + * @defgroup nse NSE service + * Network Size Estimation + * + * Provides an API to retrieve the current network size estimate, + * also to register for notifications whenever a new + * network size estimate is calculated. + * + * @see [Documentation](https://gnunet.org/gnunet-nse-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 network size estimation API. @@ -76,13 +82,14 @@ typedef void (*GNUNET_NSE_Callback) (void *cls, */ #define GNUNET_NSE_log_estimate_to_n(loge) pow(2.0, (loge)) + /** * Connect to the network size estimation service. * * @param cfg the configuration to use * @param func funtion to call with network size estimate * @param func_cls closure to pass to @a func - * @return handle to use + * @return handle to use in #GNUNET_NSE_disconnect to stop NSE from invoking the callbacks */ struct GNUNET_NSE_Handle * GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,