/*
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
Boston, MA 02110-1301, USA.
*/
/**
- * @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
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
* @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_MQ_NotifyCallback 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.
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);
/**
* 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.
*
}
#endif
-
-/* end of gnunet_peerinfo_service.h */
#endif
+
+/** @} */ /* end of group */