RECLAIM/OIDC: code cleanup

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

diff --git a/src/include/gnunet_peerinfo_service.h b/src/include/gnunet_peerinfo_service.h
index 4d2d3c805bdb0f37b67d394683e0854686243902..6fc48f806b809830fc9bc7770479c382aa5af1bf 100644 (file)
--- a/src/include/gnunet_peerinfo_service.h
+++ b/src/include/gnunet_peerinfo_service.h
@@ -1,27 +1,36 @@
 /*
      This file is part of GNUnet
-     Copyright (C) 2009, 2010 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009, 2010 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 <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_peerinfo_service.h
- * @brief Code to maintain the list of currently known hosts
- *   (in memory structure of data/hosts).
  * @author Christian Grothoff
+ *
+ * @file
+ * Maintain the list of currently known hosts
+ *
+ * @defgroup peerinfo  Peer Info service
+ * Maintain the list of currently known hosts.
+ *
+ * Holds an in-memory structure of data/hosts.
+ *
+ * @see [Documentation](https://gnunet.org/gnunets-peerinfo-subsystem)
+ *
+ * @{
  */
 
 #ifndef GNUNET_PEERINFO_SERVICE_H
@@ -71,23 +80,6 @@ void
 GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h);
 
 
-/**
- * Continuation called with a status result.
- *
- * @param cls closure
- * @param emsg error message, NULL on success
- */
-typedef void
-(*GNUNET_PEERINFO_Continuation)(void *cls,
-                                const char *emsg);
-
-
-/**
- * Opaque handle to cancel 'add' operation.
- */
-struct GNUNET_PEERINFO_AddContext;
-
-
 /**
  * Add a host to the persistent list.  This method operates in
  * semi-reliable mode: if the transmission is not completed by
@@ -103,26 +95,16 @@ struct GNUNET_PEERINFO_AddContext;
  * @return handle to cancel add operation; all pending
  *         'add' operations will be cancelled automatically
  *        on disconnect, so it is not necessary to keep this
- *        handle (unless @a cont is NULL and at some point
+ *        handle (unless @a cont is non-NULL and at some point
  *        calling @a cont must be prevented)
  */
-struct GNUNET_PEERINFO_AddContext *
+struct GNUNET_MQ_Envelope *
 GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h,
                           const struct GNUNET_HELLO_Message *hello,
-                         GNUNET_PEERINFO_Continuation cont,
+                         GNUNET_SCHEDULER_TaskCallback cont,
                          void *cont_cls);
 
 
-/**
- * Cancel pending 'add' operation.  Must only be called before
- * either 'cont' or #GNUNET_PEERINFO_disconnect() are invoked.
- *
- * @param ac handle for the add operation to cancel
- */
-void
-GNUNET_PEERINFO_add_peer_cancel (struct GNUNET_PEERINFO_AddContext *ac);
-
-
 /**
  * Type of an iterator over the hosts.  Note that each
  * host will be called with each available protocol.
@@ -166,8 +148,8 @@ struct GNUNET_PEERINFO_IteratorContext *
 GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h,
                         int include_friend_only,
                          const struct GNUNET_PeerIdentity *peer,
-                         struct GNUNET_TIME_Relative timeout,
-                         GNUNET_PEERINFO_Processor callback, void *callback_cls);
+                         GNUNET_PEERINFO_Processor callback,
+                         void *callback_cls);
 
 
 /**
@@ -190,7 +172,7 @@ struct GNUNET_PEERINFO_NotifyContext;
  * changes.  Initially calls the given function for all known
  * peers and then only signals changes.
  *
- * If include_friend_only is set to GNUNET_YES peerinfo will include HELLO
+ * If @a include_friend_only is set to #GNUNET_YES peerinfo will include HELLO
  * messages which are intended for friend to friend mode and which do not
  * have to be gossiped. Otherwise these messages are skipped.
  *
@@ -223,6 +205,6 @@ GNUNET_PEERINFO_notify_cancel (struct GNUNET_PEERINFO_NotifyContext *nc);
 }
 #endif
 
-
-/* end of gnunet_peerinfo_service.h */
 #endif
+
+/** @} */  /* end of group */