/*
This file is part of GNUnet
- (C) 2009, 2010 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2010 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
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.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
* @file include/gnunet_peerinfo_service.h
* Disconnect from the peerinfo service. Note that all iterators must
* have completed or have been cancelled by the time this function is
* called (otherwise, calling this function is a serious error).
- * Furthermore, if 'GNUNET_PEERINFO_add_peer' operations are still
+ * Furthermore, if #GNUNET_PEERINFO_add_peer() operations are still
* pending, they will be cancelled silently on disconnect.
*
* @param h handle to disconnect
* @param cls closure
* @param emsg error message, NULL on success
*/
-typedef void (*GNUNET_PEERINFO_Continuation)(void *cls,
- const char *emsg);
+typedef void
+(*GNUNET_PEERINFO_Continuation)(void *cls,
+ const char *emsg);
/**
/**
* Add a host to the persistent list. This method operates in
* semi-reliable mode: if the transmission is not completed by
- * the time 'GNUNET_PEERINFO_disconnect' is called, it will be
+ * the time #GNUNET_PEERINFO_disconnect() is called, it will be
* aborted. Furthermore, if a second HELLO is added for the
* same peer before the first one was transmitted, PEERINFO may
* merge the two HELLOs prior to transmission to the service.
* @param h handle to the peerinfo service
* @param hello the verified (!) HELLO message
* @param cont continuation to call when done, NULL is allowed
- * @param cont_cls closure for 'cont'
+ * @param cont_cls closure for @a cont
* @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 'cont' is NULL and at some point
- * calling 'cont' must be prevented)
+ * handle (unless @a cont is NULL and at some point
+ * calling @a cont must be prevented)
*/
struct GNUNET_PEERINFO_AddContext *
GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h,
/**
* Cancel pending 'add' operation. Must only be called before
- * either 'cont' or 'GNUNET_PEERINFO_disconnect' are invoked.
+ * either 'cont' or #GNUNET_PEERINFO_disconnect() are invoked.
*
* @param ac handle for the add operation to cancel
*/
* with a NULL pointer. After that final invocation, the iterator
* context must no longer be used.
*
- * Instead of calling this function with 'peer == NULL' it is often
- * better to use 'GNUNET_PEERINFO_notify'.
+ * Instead of calling this function with `peer == NULL` it is often
+ * better to use #GNUNET_PEERINFO_notify().
*
* @param h handle to the peerinfo service
* @param include_friend_only include HELLO messages for friends only
* @param peer restrict iteration to this peer only (can be NULL)
* @param timeout how long to wait until timing out
* @param callback the method to call for each peer
- * @param callback_cls closure for callback
+ * @param callback_cls closure for @a callback
* @return iterator context
*/
struct GNUNET_PEERINFO_IteratorContext *
GNUNET_PEERINFO_Processor callback, void *callback_cls);
-
/**
* Cancel an iteration over peer information.
*
GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic);
-
/**
* Handle for notifications about changes to the set of known peers.
*/
* @param cfg configuration to use
* @param include_friend_only include HELLO messages for friends only
* @param callback the method to call for each peer
- * @param callback_cls closure for callback
+ * @param callback_cls closure for @a callback
* @return NULL on error
*/
struct GNUNET_PEERINFO_NotifyContext *
GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg,
int include_friend_only,
- GNUNET_PEERINFO_Processor callback, void *callback_cls);
+ GNUNET_PEERINFO_Processor callback,
+ void *callback_cls);
/**