diff options
author | Matthias Wachs <wachs@net.in.tum.de> | 2014-01-16 10:44:27 +0000 |
---|---|---|
committer | Matthias Wachs <wachs@net.in.tum.de> | 2014-01-16 10:44:27 +0000 |
commit | e33179a1a31023a91cb70a956ecdc778eb081250 (patch) | |
tree | 423b656cbfcaa58d573efc4121aa0b392f582b13 /src | |
parent | a5343332156101de79b8ed3fa4a74c892d088a1b (diff) | |
download | gnunet-e33179a1a31023a91cb70a956ecdc778eb081250.tar.gz gnunet-e33179a1a31023a91cb70a956ecdc778eb081250.zip |
documentation for ATS
Diffstat (limited to 'src')
-rw-r--r-- | src/ats/gnunet-service-ats_addresses.c | 5 | ||||
-rw-r--r-- | src/ats/gnunet-service-ats_addresses.h | 4 | ||||
-rw-r--r-- | src/ats/gnunet-service-ats_scheduling.c | 1 | ||||
-rw-r--r-- | src/ats/gnunet-service-ats_scheduling.h | 1 |
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 index 13bd656d4..a8c859450 100644 --- 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, | |||
641 | * @param plugin_name transport plugin name | 641 | * @param plugin_name transport plugin name |
642 | * @param plugin_addr plugin address | 642 | * @param plugin_addr plugin address |
643 | * @param plugin_addr_len length of the plugin address | 643 | * @param plugin_addr_len length of the plugin address |
644 | * @param local_address_info the local address for the address | ||
644 | * @param session_id session id, can be 0 | 645 | * @param session_id session id, can be 0 |
645 | * @return an ATS_address or NULL | 646 | * @return an ATS_address or NULL |
646 | */ | 647 | */ |
@@ -730,6 +731,7 @@ get_performance_info (struct ATS_Address *address, uint32_t type) | |||
730 | * @param plugin_name transport plugin name | 731 | * @param plugin_name transport plugin name |
731 | * @param plugin_addr plugin address | 732 | * @param plugin_addr plugin address |
732 | * @param plugin_addr_len length of the plugin address | 733 | * @param plugin_addr_len length of the plugin address |
734 | * @param local_address_info the local address for the address | ||
733 | * @param session_id session id, can be 0 | 735 | * @param session_id session id, can be 0 |
734 | * @param atsi performance information for this address | 736 | * @param atsi performance information for this address |
735 | * @param atsi_count number of performance information contained | 737 | * @param atsi_count number of performance information contained |
@@ -899,6 +901,7 @@ GAS_addresses_add (struct GAS_Addresses_Handle *handle, | |||
899 | * @param plugin_name transport plugin name | 901 | * @param plugin_name transport plugin name |
900 | * @param plugin_addr plugin address | 902 | * @param plugin_addr plugin address |
901 | * @param plugin_addr_len length of the plugin address | 903 | * @param plugin_addr_len length of the plugin address |
904 | * @param local_address_info the local address for the address | ||
902 | * @param session_id session id, can be 0 | 905 | * @param session_id session id, can be 0 |
903 | * @param atsi performance information for this address | 906 | * @param atsi performance information for this address |
904 | * @param atsi_count number of performance information contained | 907 | * @param atsi_count number of performance information contained |
@@ -1095,6 +1098,7 @@ destroy_by_session_id (void *cls, | |||
1095 | * @param plugin_name transport plugin name | 1098 | * @param plugin_name transport plugin name |
1096 | * @param plugin_addr plugin address | 1099 | * @param plugin_addr plugin address |
1097 | * @param plugin_addr_len length of the plugin address | 1100 | * @param plugin_addr_len length of the plugin address |
1101 | * @param local_address_info the local address for the address | ||
1098 | * @param session_id session id, can be 0 | 1102 | * @param session_id session id, can be 0 |
1099 | */ | 1103 | */ |
1100 | void | 1104 | void |
@@ -1154,6 +1158,7 @@ GAS_addresses_destroy (struct GAS_Addresses_Handle *handle, | |||
1154 | * @param plugin_name transport plugin name | 1158 | * @param plugin_name transport plugin name |
1155 | * @param plugin_addr plugin address | 1159 | * @param plugin_addr plugin address |
1156 | * @param plugin_addr_len length of the plugin address | 1160 | * @param plugin_addr_len length of the plugin address |
1161 | * @param local_address_info the local address for the address | ||
1157 | * @param session_id session id, can be 0 | 1162 | * @param session_id session id, can be 0 |
1158 | * @param in_use GNUNET_YES if GNUNET_NO | 1163 | * @param in_use GNUNET_YES if GNUNET_NO |
1159 | * @return GNUNET_SYSERR on failure (address unknown ...) | 1164 | * @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 index a793d35d8..2af21b625 100644 --- 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); | |||
423 | * @param plugin_name transport plugin name | 423 | * @param plugin_name transport plugin name |
424 | * @param plugin_addr plugin address | 424 | * @param plugin_addr plugin address |
425 | * @param plugin_addr_len length of the plugin address | 425 | * @param plugin_addr_len length of the plugin address |
426 | * @param local_address_info the local address for the address | ||
426 | * @param session_id session id, can be 0 | 427 | * @param session_id session id, can be 0 |
427 | * @param atsi performance information for this address | 428 | * @param atsi performance information for this address |
428 | * @param atsi_count number of performance information contained | 429 | * @param atsi_count number of performance information contained |
@@ -453,6 +454,7 @@ GAS_addresses_add (struct GAS_Addresses_Handle *handle, | |||
453 | * @param plugin_name transport plugin name | 454 | * @param plugin_name transport plugin name |
454 | * @param plugin_addr plugin address | 455 | * @param plugin_addr plugin address |
455 | * @param plugin_addr_len length of the plugin address | 456 | * @param plugin_addr_len length of the plugin address |
457 | * @param local_address_info the local address for the address | ||
456 | * @param session_id session id, can be 0 | 458 | * @param session_id session id, can be 0 |
457 | * @param in_use GNUNET_YES if GNUNET_NO | 459 | * @param in_use GNUNET_YES if GNUNET_NO |
458 | * @return GNUNET_SYSERR on failure (address unknown ...) | 460 | * @return GNUNET_SYSERR on failure (address unknown ...) |
@@ -476,6 +478,7 @@ GAS_addresses_in_use (struct GAS_Addresses_Handle *handle, | |||
476 | * @param plugin_name transport plugin name | 478 | * @param plugin_name transport plugin name |
477 | * @param plugin_addr plugin address | 479 | * @param plugin_addr plugin address |
478 | * @param plugin_addr_len length of the plugin address | 480 | * @param plugin_addr_len length of the plugin address |
481 | * @param local_address_info the local address for the address | ||
479 | * @param session_id session id, can be 0 | 482 | * @param session_id session id, can be 0 |
480 | * @param atsi performance information for this address | 483 | * @param atsi performance information for this address |
481 | * @param atsi_count number of performance information contained | 484 | * @param atsi_count number of performance information contained |
@@ -496,6 +499,7 @@ GAS_addresses_update (struct GAS_Addresses_Handle *handle, | |||
496 | * @param plugin_addr plugin address | 499 | * @param plugin_addr plugin address |
497 | * @param plugin_addr_len length of the plugin address | 500 | * @param plugin_addr_len length of the plugin address |
498 | * @param session_id session id, can be 0 | 501 | * @param session_id session id, can be 0 |
502 | * @param local_address_info the local address for the address | ||
499 | */ | 503 | */ |
500 | void | 504 | void |
501 | GAS_addresses_destroy (struct GAS_Addresses_Handle *handle, | 505 | 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 index 2b77e0e5d..4c0b6423f 100644 --- 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) | |||
92 | * @param plugin_name 0-termintated string specifying the transport plugin | 92 | * @param plugin_name 0-termintated string specifying the transport plugin |
93 | * @param plugin_addr binary address for the plugin to use | 93 | * @param plugin_addr binary address for the plugin to use |
94 | * @param plugin_addr_len number of bytes in plugin_addr | 94 | * @param plugin_addr_len number of bytes in plugin_addr |
95 | * @param local_address_info the local address for the address | ||
95 | * @param session_id session ID to use for the given client (other clients will see 0) | 96 | * @param session_id session ID to use for the given client (other clients will see 0) |
96 | * @param atsi performance data for the address | 97 | * @param atsi performance data for the address |
97 | * @param atsi_count number of performance records in 'ats' | 98 | * @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 index 7733cdf88..1603437b8 100644 --- 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, | |||
72 | * @param plugin_addr binary address for the plugin to use | 72 | * @param plugin_addr binary address for the plugin to use |
73 | * @param plugin_addr_len number of bytes in plugin_addr | 73 | * @param plugin_addr_len number of bytes in plugin_addr |
74 | * @param session_id session ID to use | 74 | * @param session_id session ID to use |
75 | * @param local_address_info the local address for the address | ||
75 | * @param atsi performance data for the address | 76 | * @param atsi performance data for the address |
76 | * @param atsi_count number of performance records in 'ats' | 77 | * @param atsi_count number of performance records in 'ats' |
77 | * @param bandwidth_out assigned outbound bandwidth | 78 | * @param bandwidth_out assigned outbound bandwidth |