From a7b5be23ee4646fc0a32198e7998e86850dd3576 Mon Sep 17 00:00:00 2001 From: Matthias Wachs Date: Thu, 25 Oct 2012 14:21:46 +0000 Subject: some docu --- src/ats/gnunet-service-ats_addresses.h | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/ats/gnunet-service-ats_addresses.h b/src/ats/gnunet-service-ats_addresses.h index d6b5a72ee..693a7b8d1 100644 --- a/src/ats/gnunet-service-ats_addresses.h +++ b/src/ats/gnunet-service-ats_addresses.h @@ -163,15 +163,20 @@ GAS_addresses_add (const struct GNUNET_PeerIdentity *peer, 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 @@ typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *cls, 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); -- cgit v1.2.3