convert fs publish to MQ

[oweals/gnunet.git] / src / include / gnunet_ats_service.h

diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h
index 6a2449a7a2672d155836fc81ba2a340a541978f8..41e1a1a900ca911453543cd2ceab12bccf981c78 100644 (file)
--- a/src/include/gnunet_ats_service.h
+++ b/src/include/gnunet_ats_service.h
@@ -1,6 +1,6 @@
 /*
  This file is part of GNUnet.
- Copyright (C) 2010-2015 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010-2015 GNUnet e.V.
 
  GNUnet is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published
@@ -18,10 +18,18 @@
  Boston, MA 02110-1301, USA.
  */
 /**
- * @file include/gnunet_ats_service.h
- * @brief automatic transport selection and outbound bandwidth determination
+ * @file
+ * Automatic transport selection and outbound bandwidth determination
+ *
  * @author Christian Grothoff
  * @author Matthias Wachs
+ *
+ * @defgroup ats  ATS service
+ * Automatic Transport Selection and outbound bandwidth determination
+ *
+ * @see [Documentation](https://gnunet.org/ats-subsystem)
+ *
+ * @{
  */
 #ifndef GNUNET_ATS_SERVICE_H
 #define GNUNET_ATS_SERVICE_H
@@ -302,12 +310,13 @@ GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch);
  *
  * @param ch handle
  * @param peer identity of the peer we need an address for
- * TODO: add argument to allow client to express 'strength's of request
+ * @param strength how urgent is the need for such a suggestion
  * @return suggestion handle, NULL if request is already pending
-  */
+ */
 struct GNUNET_ATS_ConnectivitySuggestHandle *
 GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
-                                 const struct GNUNET_PeerIdentity *peer);
+                                 const struct GNUNET_PeerIdentity *peer,
+                                 uint32_t strength);
 
 
 /**
@@ -328,9 +337,8 @@ struct GNUNET_ATS_SchedulingHandle;
 
 /**
  * Opaque session handle, defined by plugins.  Contents not known to ATS.
- * FIXME: This violates our naming conventions.
  */
-struct Session;
+struct GNUNET_ATS_Session;
 
 
 /**
@@ -353,7 +361,7 @@ typedef void
 (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
                                          const struct GNUNET_PeerIdentity *peer,
                                          const struct GNUNET_HELLO_Address *address,
-                                         struct Session *session,
+                                         struct GNUNET_ATS_Session *session,
                                          struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
                                          struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 
@@ -402,7 +410,7 @@ struct GNUNET_ATS_AddressRecord;
 struct GNUNET_ATS_AddressRecord *
 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
                         const struct GNUNET_HELLO_Address *address,
-                        struct Session *session,
+                        struct GNUNET_ATS_Session *session,
                         const struct GNUNET_ATS_Properties *prop);
 
 
@@ -414,7 +422,7 @@ GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
  */
 void
 GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
-                                struct Session *session);
+                                struct GNUNET_ATS_Session *session);
 
 
 /**
@@ -431,7 +439,7 @@ GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
  */
 int
 GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
-                                struct Session *session);
+                                struct GNUNET_ATS_Session *session);
 
 
 /**
@@ -518,7 +526,7 @@ GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 /**
  * Get information about addresses known to the ATS subsystem.
  *
- * @param handle the performance handle to use
+ * @param ph the performance handle to use
  * @param peer peer idm can be NULL for all peers
  * @param all #GNUNET_YES to get information about all addresses or #GNUNET_NO to
  *        get only address currently used
@@ -528,7 +536,7 @@ GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
  * @return handle to abort the operation
  */
 struct GNUNET_ATS_AddressListHandle *
-GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
+GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *ph,
                                        const struct GNUNET_PeerIdentity *peer,
                                        int all,
                                        GNUNET_ATS_AddressInformationCallback infocb,
@@ -538,10 +546,10 @@ GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *hand
 /**
  * Cancel a pending address listing operation
  *
- * @param handle the `struct GNUNET_ATS_AddressListHandle` handle to cancel
+ * @param alh the `struct GNUNET_ATS_AddressListHandle` handle to cancel
  */
 void
-GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle);
+GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *alh);
 
 
 /**
@@ -696,4 +704,7 @@ GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
                                      ...);
 
 #endif
+
+/** @} */  /* end of group */
+
 /* end of file gnunet-service-transport_ats.h */