commit e33179a1a31023a91cb70a956ecdc778eb081250
parent a5343332156101de79b8ed3fa4a74c892d088a1b
Author: Matthias Wachs <wachs@net.in.tum.de>
Date: Thu, 16 Jan 2014 10:44:27 +0000
documentation for ATS
Diffstat:
4 files changed, 11 insertions(+), 0 deletions(-)
diff --git a/src/ats/gnunet-service-ats_addresses.c b/src/ats/gnunet-service-ats_addresses.c
@@ -641,6 +641,7 @@ find_equivalent_address (struct GAS_Addresses_Handle *handle,
* @param plugin_name transport plugin name
* @param plugin_addr plugin address
* @param plugin_addr_len length of the plugin address
+ * @param local_address_info the local address for the address
* @param session_id session id, can be 0
* @return an ATS_address or NULL
*/
@@ -730,6 +731,7 @@ get_performance_info (struct ATS_Address *address, uint32_t type)
* @param plugin_name transport plugin name
* @param plugin_addr plugin address
* @param plugin_addr_len length of the plugin address
+ * @param local_address_info the local address for the address
* @param session_id session id, can be 0
* @param atsi performance information for this address
* @param atsi_count number of performance information contained
@@ -899,6 +901,7 @@ GAS_addresses_add (struct GAS_Addresses_Handle *handle,
* @param plugin_name transport plugin name
* @param plugin_addr plugin address
* @param plugin_addr_len length of the plugin address
+ * @param local_address_info the local address for the address
* @param session_id session id, can be 0
* @param atsi performance information for this address
* @param atsi_count number of performance information contained
@@ -1095,6 +1098,7 @@ destroy_by_session_id (void *cls,
* @param plugin_name transport plugin name
* @param plugin_addr plugin address
* @param plugin_addr_len length of the plugin address
+ * @param local_address_info the local address for the address
* @param session_id session id, can be 0
*/
void
@@ -1154,6 +1158,7 @@ GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
* @param plugin_name transport plugin name
* @param plugin_addr plugin address
* @param plugin_addr_len length of the plugin address
+ * @param local_address_info the local address for the address
* @param session_id session id, can be 0
* @param in_use GNUNET_YES if GNUNET_NO
* @return GNUNET_SYSERR on failure (address unknown ...)
diff --git a/src/ats/gnunet-service-ats_addresses.h b/src/ats/gnunet-service-ats_addresses.h
@@ -423,6 +423,7 @@ GAS_addresses_done (struct GAS_Addresses_Handle *handle);
* @param plugin_name transport plugin name
* @param plugin_addr plugin address
* @param plugin_addr_len length of the plugin address
+ * @param local_address_info the local address for the address
* @param session_id session id, can be 0
* @param atsi performance information for this address
* @param atsi_count number of performance information contained
@@ -453,6 +454,7 @@ GAS_addresses_add (struct GAS_Addresses_Handle *handle,
* @param plugin_name transport plugin name
* @param plugin_addr plugin address
* @param plugin_addr_len length of the plugin address
+ * @param local_address_info the local address for the address
* @param session_id session id, can be 0
* @param in_use GNUNET_YES if GNUNET_NO
* @return GNUNET_SYSERR on failure (address unknown ...)
@@ -476,6 +478,7 @@ GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
* @param plugin_name transport plugin name
* @param plugin_addr plugin address
* @param plugin_addr_len length of the plugin address
+ * @param local_address_info the local address for the address
* @param session_id session id, can be 0
* @param atsi performance information for this address
* @param atsi_count number of performance information contained
@@ -496,6 +499,7 @@ GAS_addresses_update (struct GAS_Addresses_Handle *handle,
* @param plugin_addr plugin address
* @param plugin_addr_len length of the plugin address
* @param session_id session id, can be 0
+ * @param local_address_info the local address for the address
*/
void
GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
diff --git a/src/ats/gnunet-service-ats_scheduling.c b/src/ats/gnunet-service-ats_scheduling.c
@@ -92,6 +92,7 @@ GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client)
* @param plugin_name 0-termintated string specifying the transport plugin
* @param plugin_addr binary address for the plugin to use
* @param plugin_addr_len number of bytes in plugin_addr
+ * @param local_address_info the local address for the address
* @param session_id session ID to use for the given client (other clients will see 0)
* @param atsi performance data for the address
* @param atsi_count number of performance records in 'ats'
diff --git a/src/ats/gnunet-service-ats_scheduling.h b/src/ats/gnunet-service-ats_scheduling.h
@@ -72,6 +72,7 @@ GAS_handle_reset_backoff (void *cls,
* @param plugin_addr binary address for the plugin to use
* @param plugin_addr_len number of bytes in plugin_addr
* @param session_id session ID to use
+ * @param local_address_info the local address for the address
* @param atsi performance data for the address
* @param atsi_count number of performance records in 'ats'
* @param bandwidth_out assigned outbound bandwidth