merge

[oweals/gnunet.git] / src / include / gnunet_peerstore_service.h

diff --git a/src/include/gnunet_peerstore_service.h b/src/include/gnunet_peerstore_service.h
index 49166659bba8e4ac464cd35178e19bf0af4df11d..55f371399f2a44860ac6dd7bd4d008a2bde12f78 100644 (file)
--- a/src/include/gnunet_peerstore_service.h
+++ b/src/include/gnunet_peerstore_service.h
@@ -1,32 +1,38 @@
 /*
       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
-      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 <http://www.gnu.org/licenses/>.
 
-      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_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 +86,7 @@ struct GNUNET_PEERSTORE_Record
   /**
    * Peer Identity
    */
-  struct GNUNET_PeerIdentity *peer;
+  struct GNUNET_PeerIdentity peer;
 
   /**
    * Record key string
@@ -100,12 +106,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 +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.
  *
@@ -198,7 +207,6 @@ GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc);
  * @param sub_system name of sub system
  * @param peer Peer identity (can be NULL)
  * @param key entry key string (can be NULL)
- * @param timeout time after which the iterate request is canceled
  * @param callback function called with each matching record, all NULL's on end
  * @param callback_cls closure for @a callback
  */
@@ -207,7 +215,6 @@ GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h,
                           const char *sub_system,
                           const struct GNUNET_PeerIdentity *peer,
                           const char *key,
-                          struct GNUNET_TIME_Relative timeout,
                           GNUNET_PEERSTORE_Processor callback,
                           void *callback_cls);
 
@@ -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 */