X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_peerstore_plugin.h;h=bd5d18068b5c1f4cb577fcd177c649a79a75598f;hb=2bbb2934dbbe471640c67c3bc672120f35708fd1;hp=4ea68f31d15874c08c087230544494da978e6c5f;hpb=bd94aa6fe80a7687c3727ebcdb3ba5185d3b8b11;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_peerstore_plugin.h b/src/include/gnunet_peerstore_plugin.h index 4ea68f31d..bd5d18068 100644 --- a/src/include/gnunet_peerstore_plugin.h +++ b/src/include/gnunet_peerstore_plugin.h @@ -1,27 +1,32 @@ /* This file is part of GNUnet - (C) 2012, 2013 Christian Grothoff (and other contributing authors) + Copyright (C) 2012, 2013 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_peerstore_plugin.h - * @brief plugin API for the peerstore database backend * @author Omar Tarabai + * + * @file + * Plugin API for the peerstore database backend + * + * @defgroup peerstore-plugin Peer Store service plugin API + * Plugin API for the peerstore database backend + * @{ */ #ifndef GNUNET_PEERSTORE_PLUGIN_H #define GNUNET_PEERSTORE_PLUGIN_H @@ -67,15 +72,15 @@ struct GNUNET_PEERSTORE_PluginFunctions */ int (*store_record) (void *cls, - const char *sub_system, - const struct GNUNET_PeerIdentity *peer, - const char *key, - const void *value, - size_t size, - struct GNUNET_TIME_Absolute expiry, - enum GNUNET_PEERSTORE_StoreOption options, - GNUNET_PEERSTORE_Continuation cont, - void *cont_cls); + const char *sub_system, + const struct GNUNET_PeerIdentity *peer, + const char *key, + const void *value, + size_t size, + struct GNUNET_TIME_Absolute expiry, + enum GNUNET_PEERSTORE_StoreOption options, + GNUNET_PEERSTORE_Continuation cont, + void *cont_cls); /** * Iterate over the records given an optional peer id @@ -93,10 +98,11 @@ struct GNUNET_PEERSTORE_PluginFunctions */ int (*iterate_records) (void *cls, - const char *sub_system, - const struct GNUNET_PeerIdentity *peer, - const char *key, - GNUNET_PEERSTORE_Processor iter, void *iter_cls); + const char *sub_system, + const struct GNUNET_PeerIdentity *peer, + const char *key, + GNUNET_PEERSTORE_Processor iter, + void *iter_cls); /** * Delete expired records (expiry < now) @@ -110,9 +116,9 @@ struct GNUNET_PEERSTORE_PluginFunctions */ int (*expire_records) (void *cls, - struct GNUNET_TIME_Absolute now, - GNUNET_PEERSTORE_Continuation cont, - void *cont_cls); + struct GNUNET_TIME_Absolute now, + GNUNET_PEERSTORE_Continuation cont, + void *cont_cls); }; @@ -124,5 +130,6 @@ struct GNUNET_PEERSTORE_PluginFunctions } #endif -/* end of gnunet_peerstore_plugin.h */ #endif + +/** @} */ /* end of group */