X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_ats_service.h;h=7ea624f5e272d5541fcd9ce8d7e13feef9c3e964;hb=6e626937fd5133188d2bd06f280a1b889219eef2;hp=9f57b57e16d729b42e9902cf88668c34d3dc236f;hpb=219e64fe613c47eab4c143791128c2b453be3bf8;p=oweals%2Fgnunet.git

diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h
index 9f57b57e1..7ea624f5e 100644
--- a/src/include/gnunet_ats_service.h
+++ b/src/include/gnunet_ats_service.h
@@ -1,21 +1,21 @@
 /*
  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
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
 
  GNUnet is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- General Public License for more details.
+ Affero General Public License for more details.
 
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING.  If not, write to the
- Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+     SPDX-License-Identifier: AGPL3.0-or-later
  */
 /**
  * @file
@@ -26,6 +26,9 @@
  *
  * @defgroup ats  ATS service
  * Automatic Transport Selection and outbound bandwidth determination
+ *
+ * @see [Documentation](https://gnunet.org/ats-subsystem)
+ *
  * @{
  */
 #ifndef GNUNET_ATS_SERVICE_H
@@ -35,48 +38,6 @@
 #include "gnunet_util_lib.h"
 #include "gnunet_hello_lib.h"
 
-/**
- * Types of networks (with separate quotas) we support.
- */
-enum GNUNET_ATS_Network_Type
-{
-  /**
-   * Category of last resort.
-   */
-  GNUNET_ATS_NET_UNSPECIFIED = 0,
-
-  /**
-   * Loopback (same host).
-   */
-  GNUNET_ATS_NET_LOOPBACK = 1,
-
-  /**
-   * Local area network.
-   */
-  GNUNET_ATS_NET_LAN = 2,
-
-  /**
-   * Wide area network (i.e. Internet)
-   */
-  GNUNET_ATS_NET_WAN = 3,
-
-  /**
-   * Wireless LAN (i.e. 802.11abgn)
-   */
-  GNUNET_ATS_NET_WLAN = 4,
-
-  /**
-   * Bluetooth LAN
-   */
-  GNUNET_ATS_NET_BT = 5
-
-/**
- * Number of network types supported by ATS
- */
-#define GNUNET_ATS_NetworkTypeCount 6
-
-};
-
 
 /**
  * Default bandwidth assigned to a network : 64 KB/s
@@ -142,7 +103,7 @@ struct GNUNET_ATS_Properties
    * Which network scope does the respective address belong to?
    * This property does not change.
    */
-  enum GNUNET_ATS_Network_Type scope;
+  enum GNUNET_NetworkType scope;
 
 };
 
@@ -219,55 +180,6 @@ GNUNET_ATS_properties_ntoh (struct GNUNET_ATS_Properties *hbo,
 
 
 
-/**
- * Convert a `enum GNUNET_ATS_Network_Type` to a string
- *
- * @param net the network type
- * @return a string or NULL if invalid
- */
-const char *
-GNUNET_ATS_print_network_type (enum GNUNET_ATS_Network_Type net);
-
-
-/**
- * Handle for the LAN Characterization library.
- */
-struct GNUNET_ATS_InterfaceScanner;
-
-
-/**
- * Returns where the address is located: loopback, LAN or WAN.
- *
- * @param is handle from #GNUNET_ATS_interface_scanner_init()
- * @param addr address
- * @param addrlen address length
- * @return type of the network the address belongs to
- */
-enum GNUNET_ATS_Network_Type
-GNUNET_ATS_scanner_address_get_type (struct GNUNET_ATS_InterfaceScanner *is,
-                                     const struct sockaddr *addr,
-                                     socklen_t addrlen);
-
-
-/**
- * Initialize the ATS address characterization client handle.
- *
- * @return scanner handle, NULL on error
- */
-struct GNUNET_ATS_InterfaceScanner *
-GNUNET_ATS_scanner_init (void);
-
-
-/**
- * Terminate interface scanner.
- *
- * @param is scanner we are done with
- */
-void
-GNUNET_ATS_scanner_done (struct GNUNET_ATS_InterfaceScanner *is);
-
-
-
 /* ********************Connection Suggestion API ***************************** */
 
 /**
@@ -523,7 +435,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
@@ -533,7 +445,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,
@@ -543,10 +455,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);
 
 
 /**