X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_peerstore_service.h;h=261d2d34f04a9b07b713e5eb71b9fa2317a392e3;hb=ec50a665dc884f7997419d0351ae8ade9c1aeabe;hp=b32b29a782932b0ee0b4d1fbf6a9cf41f2afb4b3;hpb=f27338992f0a5915ee974faea05f764c2df6f584;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_peerstore_service.h b/src/include/gnunet_peerstore_service.h index b32b29a78..261d2d34f 100644 --- a/src/include/gnunet_peerstore_service.h +++ b/src/include/gnunet_peerstore_service.h @@ -2,31 +2,35 @@ This file is part of GNUnet 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 - 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. - - 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., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. + 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 . */ /** - * @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 @@ -80,7 +84,7 @@ struct GNUNET_PEERSTORE_Record /** * Peer Identity */ - struct GNUNET_PeerIdentity *peer; + struct GNUNET_PeerIdentity peer; /** * Record key string @@ -100,12 +104,13 @@ struct GNUNET_PEERSTORE_Record /** * Expiry time of entry */ - struct GNUNET_TIME_Absolute *expiry; + 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 +121,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 +131,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 +258,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 +267,5 @@ GNUNET_PEERSTORE_watch_cancel (struct GNUNET_PEERSTORE_WatchContext *wc); #endif #endif + +/** @} */ /* end of group */