X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_peerstore_service.h;h=3cafe70b855f45651fd783d461dad9f242ef3464;hb=360d7afad50d1af425a20e89419d2063a6a0e220;hp=49166659bba8e4ac464cd35178e19bf0af4df11d;hpb=fb12af8319a84389a536ab2f3735daf3b24f11bd;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_peerstore_service.h b/src/include/gnunet_peerstore_service.h index 49166659b..3cafe70b8 100644 --- a/src/include/gnunet_peerstore_service.h +++ b/src/include/gnunet_peerstore_service.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet - (C) + Copyright (C) GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -14,19 +14,25 @@ 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. */ /** - * @file include/gnunet_peerstore_service.h - * @brief API to the peerstore service * @author Omar Tarabai + * + * @file + * API to the peerstore service + * + * @defgroup peerstore Peer Store service + * + * @see [Documentation](https://gnunet.org/gnunets-peerstore-subsystem) + * + * @{ */ #ifndef GNUNET_PEERSTORE_SERVICE_H #define GNUNET_PEERSTORE_SERVICE_H -#include "platform.h" #include "gnunet_util_lib.h" #ifdef __cplusplus @@ -103,9 +109,10 @@ struct GNUNET_PEERSTORE_Record struct GNUNET_TIME_Absolute *expiry; /** - * Client from which this record originated + * Client from which this record originated. + * NOTE: This is internal to the service. */ - struct GNUNET_SERVER_Client *client; + struct GNUNET_SERVICE_Client *client; }; @@ -116,7 +123,9 @@ struct GNUNET_PEERSTORE_Record * @param success #GNUNET_OK or #GNUNET_SYSERR */ typedef void -(*GNUNET_PEERSTORE_Continuation)(void *cls, int success); +(*GNUNET_PEERSTORE_Continuation)(void *cls, + int success); + /** * Function called by PEERSTORE for each matching record. @@ -124,13 +133,13 @@ typedef void * @param cls closure * @param record peerstore record information * @param emsg error message, or NULL if no errors - * @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop */ -typedef int +typedef void (*GNUNET_PEERSTORE_Processor) (void *cls, const struct GNUNET_PEERSTORE_Record *record, const char *emsg); + /** * Connect to the PEERSTORE service. * @@ -251,6 +260,7 @@ GNUNET_PEERSTORE_watch (struct GNUNET_PEERSTORE_Handle *h, void GNUNET_PEERSTORE_watch_cancel (struct GNUNET_PEERSTORE_WatchContext *wc); + #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -259,3 +269,5 @@ GNUNET_PEERSTORE_watch_cancel (struct GNUNET_PEERSTORE_WatchContext *wc); #endif #endif + +/** @} */ /* end of group */