[GNUnet-SVN] r17439 - gnunet/src/include

[gnunet]

Author: grothoff
Date: 2011-10-13 15:17:11 +0200 (Thu, 13 Oct 2011)
New Revision: 17439

Modified:
   gnunet/src/include/gnunet_ats_service.h
   gnunet/src/include/gnunet_client_lib.h
Log:
renaming

Modified: gnunet/src/include/gnunet_ats_service.h
===================================================================
--- gnunet/src/include/gnunet_ats_service.h     2011-10-13 13:16:54 UTC (rev 
17438)
+++ gnunet/src/include/gnunet_ats_service.h     2011-10-13 13:17:11 UTC (rev 
17439)
@@ -44,6 +44,12 @@
 
 
 /**
+ * Opaque session handle, defined by plugins.  Contents not known to ATS.
+ */
+struct Session;
+
+
+/**
  * Signature of a function called by ATS with the current bandwidth
  * and address preferences as determined by ATS.  
  *
@@ -76,34 +82,34 @@
  * Initialize the ATS subsystem.
  *
  * @param cfg configuration to use
- * @param alloc_cb notification to call whenever the allocation changed
- * @param alloc_cb_cls closure for 'alloc_cb'
+ * @param suggest_cb notification to call whenever the suggestation changed
+ * @param suggest_cb_cls closure for 'suggest_cb'
  * @return ats context
  */
 struct GNUNET_ATS_SchedulingHandle *
 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                           GNUNET_ATS_AddressSuggestionCallback alloc_cb,
-                           void *alloc_cb_cls);
+                           GNUNET_ATS_AddressSuggestionCallback suggest_cb,
+                           void *suggest_cb_cls);
 
 
 /**
  * Client is done with ATS scheduling, release resources.
  *
- * @param atc handle to release
+ * @param sh handle to release
  */
 void
-GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *atc);
+GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
 
 
 /**
  * We would like to establish a new connection with a peer.  ATS
  * should suggest a good address to begin with.
  *
- * @param atc handle
+ * @param sh handle
  * @param peer identity of the peer we need an address for
  */
 void
-GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *atc,
+GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
                             const struct GNUNET_PeerIdentity *peer);
 
 
@@ -115,7 +121,7 @@
  * which case the call may be ignored or the information may be stored
  * for later use).  Update bandwidth assignments.
  *
- * @param atc handle
+ * @param sh handle
  * @param peer identity of the new peer
  * @param plugin_name name of the transport plugin
  * @param plugin_addr address  (if available)
@@ -125,7 +131,7 @@
  * @param ats_count number of performance records in 'ats'
  */
 void
-GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *atc,
+GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
                            const struct GNUNET_PeerIdentity *peer,
                            const char *plugin_name,
                            const void *plugin_addr, size_t plugin_addr_len,
@@ -137,20 +143,20 @@
 /**
  * A session got destroyed, stop including it as a valid address.
  *
- * @param atc handle
+ * @param sh handle
  * @param peer identity of the peer
  * @param plugin_name name of the transport plugin
  * @param plugin_addr address  (if available)
  * @param plugin_addr_len number of bytes in plugin_addr
- * @param session session handle that is no longer valid
+ * @param session session handle that is no longer valid (if available)
  */
 void
-GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *atc,
+GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
                               const struct GNUNET_PeerIdentity *peer,
                              const char *plugin_name,
                              const void *plugin_addr, 
                              size_t plugin_addr_len,
-                              const struct Session *session);
+                             struct Session *session);
 
 
 /* ******************************** Performance API 
***************************** */
@@ -197,7 +203,7 @@
  * Get handle to access performance API of the ATS subsystem.
  *
  * @param cfg configuration to use
- * @param infocb function to call on allocation changes, can be NULL
+ * @param infocb function to call on performance changes, can be NULL
  * @param infocb_cls closure for infocb
  * @return ats performance context
  */
@@ -210,10 +216,10 @@
 /**
  * Client is done using the ATS performance subsystem, release resources.
  *
- * @param atc handle
+ * @param ph handle
  */
 void
-GNUNET_ATS_performance_done (struct GNUNET_ATS_SchedulingHandle *atc);
+GNUNET_ATS_performance_done (struct GNUNET_ATS_SchedulingHandle *ph);
 
 
 /**
@@ -248,7 +254,7 @@
  * the current amount of traffic we receive from the peer and ensure
  * that the peer could add 'amount' of data to its stream.
  *
- * @param h core handle
+ * @param ph performance handle
  * @param peer identifies the peer
  * @param amount reserve N bytes for receiving, negative
  *                amounts can be used to undo a (recent) reservation;
@@ -258,7 +264,7 @@
  * @deprecated will be replaced soon
  */
 struct GNUNET_ATS_ReservationContext *
-GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *h,
+GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
                              const struct GNUNET_PeerIdentity *peer,
                              int32_t amount, 
                              GNUNET_ATS_ReservationCallback info, 
@@ -311,12 +317,12 @@
  * Change preferences for the given peer. Preference changes are forgotten if 
peers
  * disconnect.
  * 
- * @param cls closure
+ * @param ph performance handle
  * @param peer identifies the peer
  * @param ... 0-terminated specification of the desired changes
  */
 void
-GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *h,
+GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
                              const struct GNUNET_PeerIdentity *peer,
                              ...);
 

Modified: gnunet/src/include/gnunet_client_lib.h
===================================================================
--- gnunet/src/include/gnunet_client_lib.h      2011-10-13 13:16:54 UTC (rev 
17438)
+++ gnunet/src/include/gnunet_client_lib.h      2011-10-13 13:17:11 UTC (rev 
17439)
@@ -89,6 +89,7 @@
 GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock,
                           int finish_pending_write);
 
+
 /**
  * Type of a function to call when we receive a message
  * from the service.
@@ -100,6 +101,7 @@
                                               const struct GNUNET_MessageHeader
                                               * msg);
 
+
 /**
  * Type of a function to call when we have finished shutting
  * down a service, or failed.
@@ -112,6 +114,7 @@
  */
 typedef void (*GNUNET_CLIENT_ShutdownTask) (void *cls, int reason);
 
+
 /**
  * Read from the service.
  *