adding number of preferences to allow iterating over preferences

[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 b428f49a43a7b5ee509794cea97f1b337a9d4d96..4d2d3c805bdb0f37b67d394683e0854686243902 100644 (file)
--- a/src/include/gnunet_peerinfo_service.h
+++ b/src/include/gnunet_peerinfo_service.h
@@ -1,6 +1,6 @@
 /*
      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
@@ -62,7 +62,7 @@ GNUNET_PEERINFO_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
  * 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
@@ -73,12 +73,13 @@ 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);
+typedef void
+(*GNUNET_PEERINFO_Continuation)(void *cls,
+                                const char *emsg);
 
 
 /**
@@ -90,7 +91,7 @@ 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
- * 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.
@@ -98,12 +99,12 @@ struct GNUNET_PEERINFO_AddContext;
  * @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,
@@ -114,7 +115,7 @@ 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
  */
@@ -131,11 +132,11 @@ GNUNET_PEERINFO_add_peer_cancel (struct GNUNET_PEERINFO_AddContext *ac);
  * @param hello hello message for the peer (can be NULL)
  * @param error message
  */
-typedef void (*GNUNET_PEERINFO_Processor) (void *cls,
-                                           const struct GNUNET_PeerIdentity *
-                                           peer,
-                                           const struct GNUNET_HELLO_Message *
-                                           hello, const char *err_msg);
+typedef void
+(*GNUNET_PEERINFO_Processor) (void *cls,
+                              const struct GNUNET_PeerIdentity *peer,
+                              const struct GNUNET_HELLO_Message *hello,
+                              const char *err_msg);
 
 
 /**
@@ -150,15 +151,15 @@ struct GNUNET_PEERINFO_IteratorContext;
  * 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 *
@@ -169,7 +170,6 @@ GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h,
                          GNUNET_PEERINFO_Processor callback, void *callback_cls);
 
 
-
 /**
  * Cancel an iteration over peer information.
  *
@@ -179,7 +179,6 @@ void
 GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic);
 
 
-
 /**
  * Handle for notifications about changes to the set of known peers.
  */
@@ -198,13 +197,14 @@ struct GNUNET_PEERINFO_NotifyContext;
  * @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);
 
 
 /**