/*
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., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, 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 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
#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
struct GNUNET_ATS_Properties
{
+ /**
+ * Delay. Time between when the time packet is sent and the packet
+ * arrives. FOREVER if we did not measure yet.
+ */
+ struct GNUNET_TIME_Relative delay;
+
/**
* Actual traffic on this connection from this peer to the other peer.
* Includes transport overhead.
*/
uint32_t utilization_in;
- /**
- * Which network scope does the respective address belong to?
- * This property does not change.
- */
- enum GNUNET_ATS_Network_Type scope;
-
/**
* Distance on network layer (required for distance-vector routing)
* in hops. Zero for direct connections (i.e. plain TCP/UDP).
unsigned int distance;
/**
- * Delay. Time between when the time packet is sent and the packet
- * arrives. FOREVER if we did not measure yet.
+ * Which network scope does the respective address belong to?
+ * This property does not change.
*/
- struct GNUNET_TIME_Relative delay;
+ enum GNUNET_NetworkType scope;
};
-/**
- * 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 ***************************** */
/**
*
* @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);
/**
/**
* Opaque session handle, defined by plugins. Contents not known to ATS.
- * FIXME: This violates our naming conventions.
*/
-struct Session;
+struct GNUNET_ATS_Session;
+
/**
* Signature of a function called by ATS with the current bandwidth
- * and address preferences as determined by ATS.
+ * and address preferences as determined by ATS. If our connection
+ * to ATS dies and thus all suggestions become invalid, this function
+ * is called ONCE with all arguments (except @a cls) being NULL/0.
*
* @param cls closure
* @param peer for which we suggest an address, NULL if ATS connection died
(*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);
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);
*/
void
GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
- struct Session *session);
+ struct GNUNET_ATS_Session *session);
/**
- * A session was destroyed, disassociate it from the
- * given address record. If this was an incoming
- * addess, destroy the address as well.
+ * A @a session was destroyed, disassociate it from the given address
+ * record. If this was an incoming addess, destroys the address as
+ * well.
*
* @param ar address record to update information for
* @param session session handle
*/
int
GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
- struct Session *session);
+ struct GNUNET_ATS_Session *session);
/**
/**
* 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);
/**
GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
-/**
- * Number of preference types supported by ATS
- */
-#define GNUNET_ATS_PreferenceCount 3
-
/**
* ATS preference types as array initializer
*/
-#define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_END, GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY}
+#define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY, GNUNET_ATS_PREFERENCE_END}
/**
* ATS preference types as string array initializer
...);
#endif
+
+/** @} */ /* end of group */
+
/* end of file gnunet-service-transport_ats.h */
projects / oweals / gnunet.git / blobdiff