[GNUnet-SVN] r24544 - gnunet/src/ats

[gnunet]

Author: wachs
Date: 2012-10-25 16:21:46 +0200 (Thu, 25 Oct 2012)
New Revision: 24544

Modified:
   gnunet/src/ats/gnunet-service-ats_addresses.h
Log:
some docu

Modified: gnunet/src/ats/gnunet-service-ats_addresses.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses.h       2012-10-25 14:21:25 UTC 
(rev 24543)
+++ gnunet/src/ats/gnunet-service-ats_addresses.h       2012-10-25 14:21:46 UTC 
(rev 24544)
@@ -163,15 +163,20 @@
                       const struct GNUNET_ATS_Information *atsi,
                       uint32_t atsi_count);
 
-/* FIXME: add performance request API */
 
-typedef void (*GNUNET_ATS_Peer_Iterator) (void *cls,
+typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
                                           const struct GNUNET_PeerIdentity 
*id);
 
+/**
+ * Return all peers currently known to ATS
+ *
+ * @param p_it the iterator to call for every peer
+ * @param p_it_cls the closure for the iterator
+ */
 void
-GAS_addresses_iterate_peers (GNUNET_ATS_Peer_Iterator p_it, void *cls);
+GAS_addresses_iterate_peers (GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls);
 
-typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *cls,
+typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
     const struct GNUNET_PeerIdentity *id,
     const char *plugin_name,
     const void *plugin_addr, size_t plugin_addr_len,
@@ -181,6 +186,12 @@
     bandwidth_out,
     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 
+/**
+ * Return all peers currently known to ATS
+ *
+ * @param p_it the iterator to call for every peer
+ * @param p_it_cls the closure for the iterator
+ */
 void
 GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer, 
GNUNET_ATS_PeerInfo_Iterator pi_it, void *pi_it_cls);