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

[gnunet]

Author: wachs
Date: 2012-12-13 10:11:10 +0100 (Thu, 13 Dec 2012)
New Revision: 25436

Modified:
   gnunet/src/ats/gnunet-service-ats_addresses.c
   gnunet/src/ats/gnunet-service-ats_addresses_mlp.c
   gnunet/src/ats/gnunet-service-ats_addresses_mlp.h
   gnunet/src/ats/gnunet-service-ats_addresses_simplistic.c
   gnunet/src/ats/gnunet-service-ats_addresses_simplistic.h
   gnunet/src/ats/gnunet-service-ats_performance.c
   gnunet/src/ats/gnunet-service-ats_performance.h
   gnunet/src/ats/gnunet-service-ats_scheduling.c
   gnunet/src/ats/gnunet-service-ats_scheduling.h
Log:
- doxygen


Modified: gnunet/src/ats/gnunet-service-ats_addresses.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses.c       2012-12-12 23:00:05 UTC 
(rev 25435)
+++ gnunet/src/ats/gnunet-service-ats_addresses.c       2012-12-13 09:11:10 UTC 
(rev 25436)
@@ -321,6 +321,7 @@
 /**
  * Destroy the given address.
  *
+ * @param handle the address handle
  * @param addr address to destroy
  * @return GNUNET_YES if bandwidth allocations should be recalcualted
  */
@@ -421,6 +422,7 @@
  * Compares by peer identity and network address OR by session ID
  * (one of the two must match).
  *
+ * @param handle the address handle
  * @param peer peer to lookup addresses for
  * @param addr existing address record
  * @return existing address record, NULL for none
@@ -794,6 +796,7 @@
 /**
  * Cancel address suggestions for a peer
  *
+ * @param handle the address handle
  * @param peer the respective peer
  */
 void
@@ -829,6 +832,7 @@
 /**
  * Add an address suggestions for a peer
  *
+ * @param handle the address handle
  * @param peer the respective peer
  */
 void
@@ -1268,6 +1272,7 @@
 /**
  * Return all peers currently known to ATS
  *
+ * @param handle the address handle
  * @param p_it the iterator to call for every peer, callbach with id == NULL
  *        when done
  * @param p_it_cls the closure for the iterator
@@ -1332,6 +1337,7 @@
 /**
  * Return all peers currently known to ATS
  *
+ * @param handle the address handle
  * @param peer the respective peer
  * @param pi_it the iterator to call for every peer
  * @param pi_it_cls the closure for the iterator

Modified: gnunet/src/ats/gnunet-service-ats_addresses_mlp.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses_mlp.c   2012-12-12 23:00:05 UTC 
(rev 25435)
+++ gnunet/src/ats/gnunet-service-ats_addresses_mlp.c   2012-12-13 09:11:10 UTC 
(rev 25436)
@@ -339,6 +339,7 @@
   return GNUNET_OK;
 }
 
+#if 0
 /**
  * Find the required ATS information for an address
  *
@@ -347,7 +348,6 @@
  *
  * @return the index on success, otherwise GNUNET_SYSERR
  */
-#if 0
 static int
 mlp_lookup_ats (struct ATS_Address *addr, int ats_index)
 {
@@ -1073,6 +1073,12 @@
  *
  * @param cfg the GNUNET_CONFIGURATION_Handle handle
  * @param stats the GNUNET_STATISTICS handle
+ * @param network array of GNUNET_ATS_NetworkType with length dest_length
+ * @param out_dest array of outbound quotas
+ * @param in_dest array of outbound quota
+ * @param dest_length array length for quota arrays
+ * @param bw_changed_cb callback for changed bandwidth amounts
+ * @param bw_changed_cb_cls cls for callback
  * @return struct GAS_MLP_Handle on success, NULL on fail
  */
 void *
@@ -1544,10 +1550,13 @@
  * Otherwise the addresses' values can be updated and the existing base can
  * be reused
  *
- * @param solver the MLP Handle
- * @param addresses the address hashmap
- *        the address has to be already removed from the hashmap
- * @param address the address to update
+ * @param solver the solver Handle
+ * @param addresses the address hashmap containing all addresses
+ * @param address the update address
+ * @param session the new session (if changed otherwise current)
+ * @param in_use the new address in use state (if changed otherwise current)
+ * @param atsi the latest ATS information
+ * @param atsi_count the atsi count
  */
 void
 GAS_mlp_address_update (void *solver,

Modified: gnunet/src/ats/gnunet-service-ats_addresses_mlp.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses_mlp.h   2012-12-12 23:00:05 UTC 
(rev 25435)
+++ gnunet/src/ats/gnunet-service-ats_addresses_mlp.h   2012-12-13 09:11:10 UTC 
(rev 25436)
@@ -316,7 +316,12 @@
  *
  * @param cfg configuration handle
  * @param stats the GNUNET_STATISTICS handle
- * @param bw_changed_cb callback to call when assigned changes
+ * @param network array of GNUNET_ATS_NetworkType with length dest_length
+ * @param out_dest array of outbound quotas
+ * @param in_dest array of outbound quota
+ * @param dest_length array length for quota arrays
+ * @param bw_changed_cb callback for changed bandwidth amounts
+ * @param bw_changed_cb_cls cls for callback
  * @return struct GAS_MLP_Handle on success, NULL on fail
  */
 void *
@@ -349,10 +354,13 @@
  * Otherwise the addresses' values can be updated and the existing base can
  * be reused
  *
- * @param solver the MLP Handle
- * @param addresses the address hashmap
- *        the address has to be already added from the hashmap
- * @param address the address to update
+ * @param solver the solver Handle
+ * @param addresses the address hashmap containing all addresses
+ * @param address the update address
+ * @param session the new session (if changed otherwise current)
+ * @param in_use the new address in use state (if changed otherwise current)
+ * @param atsi the latest ATS information
+ * @param atsi_count the atsi count
  */
 void
 GAS_mlp_address_update (void *solver,

Modified: gnunet/src/ats/gnunet-service-ats_addresses_simplistic.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses_simplistic.c    2012-12-12 
23:00:05 UTC (rev 25435)
+++ gnunet/src/ats/gnunet-service-ats_addresses_simplistic.c    2012-12-13 
09:11:10 UTC (rev 25436)
@@ -135,7 +135,10 @@
  * @param stats the GNUNET_STATISTICS handle
  * @param network array of GNUNET_ATS_NetworkType with length dest_length
  * @param out_quota array of outbound quotas
- * param in_quota array of outbound quota
+ * @param in_quota array of outbound quota
+ * @param dest_length array length for quota arrays
+ * @param bw_changed_cb callback for changed bandwidth amounts
+ * @param bw_changed_cb_cls cls for callback
  * @return handle for the solver on success, NULL on fail
  */
 void *
@@ -241,7 +244,8 @@
 /**
  * Update the quotas for a network type
  *
- * @param network the network type to update
+ * @param s the solver handle
+ * @param net the network type to update
  * @param address_except address excluded from notifcation, since we suggest
  * this address
  */
@@ -415,6 +419,10 @@
  * @param solver the solver Handle
  * @param addresses the address hashmap containing all addresses
  * @param address the update address
+ * @param session the new session (if changed otherwise current)
+ * @param in_use the new address in use state (if changed otherwise current)
+ * @param atsi the latest ATS information
+ * @param atsi_count the atsi count
  */
 void
 GAS_simplistic_address_update (void *solver,

Modified: gnunet/src/ats/gnunet-service-ats_addresses_simplistic.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses_simplistic.h    2012-12-12 
23:00:05 UTC (rev 25435)
+++ gnunet/src/ats/gnunet-service-ats_addresses_simplistic.h    2012-12-13 
09:11:10 UTC (rev 25436)
@@ -48,8 +48,10 @@
  * @param stats the GNUNET_STATISTICS handle
  * @param network array of GNUNET_ATS_NetworkType with length dest_length
  * @param out_quota array of outbound quotas
- * param in_quota array of outbound quota
- * @param bw_changed_cb callback to call when assigned changes
+ * @param in_quota array of outbound quota
+ * @param dest_length array length for quota arrays
+ * @param bw_changed_cb callback for changed bandwidth amounts
+ * @param bw_changed_cb_cls cls for callback
  * @return handle for the solver on success, NULL on fail
  */
 void *
@@ -87,6 +89,10 @@
  * @param solver the solver Handle
  * @param addresses the address hashmap containing all addresses
  * @param address the update address
+ * @param session the new session (if changed otherwise current)
+ * @param in_use the new address in use state (if changed otherwise current)
+ * @param atsi the latest ATS information
+ * @param atsi_count the atsi count
  */
 void
 GAS_simplistic_address_update (void *solver,

Modified: gnunet/src/ats/gnunet-service-ats_performance.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats_performance.c     2012-12-12 23:00:05 UTC 
(rev 25435)
+++ gnunet/src/ats/gnunet-service-ats_performance.c     2012-12-13 09:11:10 UTC 
(rev 25436)
@@ -554,7 +554,8 @@
  * @param message the request message
  */
 void
-GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
+GAS_handle_preference_change (void *cls,
+                              struct GNUNET_SERVER_Client *client,
                               const struct GNUNET_MessageHeader *message)
 {
   const struct ChangePreferenceMessage *msg;
@@ -598,6 +599,7 @@
  * Initialize performance subsystem.
  *
  * @param server handle to our server
+ * @param addresses the address handle to use
  */
 void
 GAS_performance_init (struct GNUNET_SERVER_Handle *server,

Modified: gnunet/src/ats/gnunet-service-ats_performance.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats_performance.h     2012-12-12 23:00:05 UTC 
(rev 25435)
+++ gnunet/src/ats/gnunet-service-ats_performance.h     2012-12-13 09:11:10 UTC 
(rev 25436)
@@ -87,7 +87,8 @@
  * @param message the request message
  */
 void
-GAS_handle_request_address_list (void *cls, struct GNUNET_SERVER_Client 
*client,
+GAS_handle_request_address_list (void *cls,
+                                 struct GNUNET_SERVER_Client *client,
                                  const struct GNUNET_MessageHeader *message);
 
 /**
@@ -98,7 +99,8 @@
  * @param message the request message
  */
 void
-GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
+GAS_handle_reservation_request (void *cls,
+                                struct GNUNET_SERVER_Client *client,
                                 const struct GNUNET_MessageHeader *message);
 
 
@@ -110,7 +112,8 @@
  * @param message the request message
  */
 void
-GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
+GAS_handle_preference_change (void *cls,
+                              struct GNUNET_SERVER_Client *client,
                               const struct GNUNET_MessageHeader *message);
 
 
@@ -118,6 +121,7 @@
  * Initialize performance subsystem.
  *
  * @param server handle to our server
+ * @param addresses the address handle to use
  */
 void
 GAS_performance_init (struct GNUNET_SERVER_Handle *server,

Modified: gnunet/src/ats/gnunet-service-ats_scheduling.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats_scheduling.c      2012-12-12 23:00:05 UTC 
(rev 25435)
+++ gnunet/src/ats/gnunet-service-ats_scheduling.c      2012-12-13 09:11:10 UTC 
(rev 25436)
@@ -482,6 +482,7 @@
  * Initialize scheduling subsystem.
  *
  * @param server handle to our server
+ * @param ah the address handle to use
  */
 void
 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct 
GAS_Addresses_Handle *ah)

Modified: gnunet/src/ats/gnunet-service-ats_scheduling.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats_scheduling.h      2012-12-12 23:00:05 UTC 
(rev 25435)
+++ gnunet/src/ats/gnunet-service-ats_scheduling.h      2012-12-13 09:11:10 UTC 
(rev 25436)
@@ -159,7 +159,8 @@
  * @param message the request message
  */
 void
-GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
+GAS_handle_address_destroyed (void *cls,
+                              struct GNUNET_SERVER_Client *client,
                               const struct GNUNET_MessageHeader *message);
 
 
@@ -167,9 +168,10 @@
  * Initialize scheduling subsystem.
  *
  * @param server handle to our server
+ * @param ah the address handle to use
  */
 void
-GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct 
GAS_Addresses_Handle *addresses);
+GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct 
GAS_Addresses_Handle *ah);
 
 
 /**