/*
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
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
/**
* Bluetooth LAN
*/
- GNUNET_ATS_NET_BT = 5
+ GNUNET_ATS_NET_BT = 5,
/**
* Number of network types supported by ATS
/**
* 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
* @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,
/**
* 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);
/**
...);
#endif
+
+/** @} */ /* end of group */
+
/* end of file gnunet-service-transport_ats.h */