2 This file is part of GNUnet.
3 (C) 2010,2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
21 * @file include/gnunet_ats_service.h
22 * @brief automatic transport selection and outbound bandwidth determination
23 * @author Christian Grothoff
24 * @author Matthias Wachs
26 #ifndef GNUNET_ATS_SERVICE_H
27 #define GNUNET_ATS_SERVICE_H
29 #include "gnunet_constants.h"
30 #include "gnunet_util_lib.h"
31 #include "gnunet_hello_lib.h"
34 * Number of network types supported by ATS
36 #define GNUNET_ATS_NetworkTypeCount 6
39 * ATS network types as array initializer
41 #define GNUNET_ATS_NetworkType {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN, GNUNET_ATS_NET_BT}
44 * ATS network types as string array initializer
46 #define GNUNET_ATS_NetworkTypeString {"UNSPECIFIED", "LOOPBACK", "LAN", "WAN", "WLAN", "BLUETOOTH"}
48 enum GNUNET_ATS_Network_Type
50 GNUNET_ATS_NET_UNSPECIFIED = 0,
51 GNUNET_ATS_NET_LOOPBACK = 1,
52 GNUNET_ATS_NET_LAN = 2,
53 GNUNET_ATS_NET_WAN = 3,
54 GNUNET_ATS_NET_WLAN = 4,
59 * Default bandwidth assigned to a network : 64 KB/s
61 #define GNUNET_ATS_DefaultBandwidth 65536
64 * Undefined value for a GNUNET_ATS_Property
66 #define GNUNET_ATS_VALUE_UNDEFINED UINT32_MAX
69 * String representation for GNUNET_ATS_VALUE_UNDEFINED
71 #define GNUNET_ATS_VALUE_UNDEFINED_STR "undefined"
74 * Maximum bandwidth assigned to a network : 4095 MB/s
76 #define GNUNET_ATS_MaxBandwidth UINT32_MAX
79 * Textual equivalent for GNUNET_ATS_MaxBandwidth
81 #define GNUNET_ATS_MaxBandwidthString "unlimited"
84 * Number of property types supported by ATS
86 #define GNUNET_ATS_PropertyCount 11
89 * ATS properties types as string array initializer
91 #define GNUNET_ATS_PropertyStrings {"TERMINATOR", "UTILIZATION_UP", "UTILIZATION_DOWN", "UTILIZATION_PAYLOAD_UP", "UTILIZATION_PAYLOAD_DOWN", "NETWORK_TYPE", "DELAY", "DISTANCE", "COST_WAN", "COST_LAN", "COST_WLAN"}
94 * Enum defining all known property types for ATS Enum values are used
95 * in the GNUNET_ATS_Information struct as
98 * Cost are always stored in uint32_t, so all units used to define costs
99 * have to be normalized to fit in uint32_t [0 .. UINT32_MAX-1]
101 * UINT32_MAX is reserved for uninitialized values GNUNET_ATS_VALUE_UNDEFINED
103 enum GNUNET_ATS_Property
110 GNUNET_ATS_ARRAY_TERMINATOR = 0,
113 * Actual traffic on this connection from this peer to the other peer.
114 * Includes transport overhead
116 * Unit: [bytes/second]
118 GNUNET_ATS_UTILIZATION_OUT,
121 * Actual traffic on this connection from the other peer to this peer.
122 * Includes transport overhead
124 * Unit: [bytes/second]
126 GNUNET_ATS_UTILIZATION_IN,
130 * Actual traffic on this connection from this peer to the other peer.
131 * Only payload from layers > transport
133 * Unit: [bytes/second]
135 GNUNET_ATS_UTILIZATION_PAYLOAD_OUT,
138 * Actual traffic on this connection from the other peer to this peer.
139 * Only payload from layers > transport
141 * Unit: [bytes/second]
143 GNUNET_ATS_UTILIZATION_PAYLOAD_IN,
146 * Is this address located in WAN, LAN or a loopback address
147 * Value is element of GNUNET_ATS_Network_Type
149 GNUNET_ATS_NETWORK_TYPE,
153 * Time between when the time packet is sent and the packet arrives
155 * Unit: [microseconds]
163 GNUNET_ATS_QUALITY_NET_DELAY,
166 * Distance on network layer (required for distance-vector routing).
170 GNUNET_ATS_QUALITY_NET_DISTANCE,
173 * Network overhead on WAN (Wide-Area Network)
175 * How many bytes are sent on the WAN when 1 kilobyte (1024 bytes)
176 * of application data is transmitted?
177 * A factor used with connect cost, bandwidth cost and energy cost
178 * to describe the overhead produced by the transport protocol
182 * Interpretation: less is better
186 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
187 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
188 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
189 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
194 * Network overhead on LAN (Local-Area Network)
196 * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes)
197 * of application data is transmitted?
198 * A factor used with connect cost, bandwidth cost and energy cost
199 * to describe the overhead produced by the transport protocol
203 * Interpretation: less is better
207 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
208 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
209 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
210 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
215 * Network overhead on WLAN (Wireless Local Area Network)
217 * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes)
218 * of application data is transmitted?
219 * A factor used with connect cost, bandwidth cost and energy cost
220 * to describe the overhead produced by the transport protocol
224 * Interpretation: less is better
228 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
229 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
230 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
231 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
234 /* Cost related values */
235 /* =================== */
237 * Volume based cost in financial units to transmit data
239 * Note: This value is not bound to a specific currency or unit and only
241 * "cent" just refers the smallest amount of money in the respective
246 * Interpretation: less is better
252 // GNUNET_ATS_COST_FINANCIAL_PER_VOLUME = 1,
254 * Time based cost in financial units to transmit data
256 * Note: This value is not bound to a specific currency or unit and only
258 * "cent" just refers the smallest amount of money in the respective
263 * Interpretation: less is better
267 * Dialup: 10 [cent/h]
269 // GNUNET_ATS_COST_FINANCIAL_PER_TIME = 2,
271 * Computational costs
273 * Effort of preparing data to be sent with this transport
274 * Includes encoding, encryption and conversion of data
275 * Partial values can be summed up: c_sum = c_enc + c_enc + c_conv
276 * Resulting values depend on local system properties, e.g. CPU
280 * Interpretation: less is better
284 * HTTPS with AES CBC-256: 7,382
285 * HTTPS with AES CBC-128: 5,279
286 * HTTPS with RC4-1024: 2,652
288 // GNUNET_ATS_COST_COMPUTATIONAL = 3,
292 * Energy consumption using this transport when sending with a certain
293 * power at a certain bitrate. This is only an approximation based on:
294 * Energy consumption E = P / D
297 * Power P in Watt (J/s)
298 * Datarate D in MBit/s
300 * Conversion between power P and dBm used by WLAN in radiotap's dBm TX power:
302 * Lp(dbm) = 10 log10 (P/ 1mW)
304 * => P = 1 mW * 10^(Lp(dbm)/10)
308 * Interpretation: less is better
313 * WLAN: 89 (600 mW @ 802.11g /w 54 MBit/s)
314 * Bluetooth: 267 (100 mW @ BT2.0 EDR /w 3 MBit/s)
316 // GNUNET_ATS_COST_ENERGY_CONSUMPTION = 4,
319 * How many bytes are transmitted to initiate a new connection using
324 * Interpretation: less is better
328 * UDP (No connection) :
330 * TCP (TCP 3-Way handshake):
331 * 220 bytes Ethernet, 172 bytes TCP/IP, 122 bytes TCP
332 * HTTP (TCP + Header) :
333 * 477 bytes Ethernet, 429 bytes TCP/IP, 374 bytes TCP, 278 bytes HTTP
334 * HTTPS HTTP+TLS Handshake:
335 * 2129 bytes Ethernet, 1975 bytes TCP/IP, 1755 bytes TCP, 1403 bytes HTTPS
338 // GNUNET_ATS_COST_CONNECT = 5,
342 * How many bandwidth is available to consume?
343 * Used to calculate which impact sending data with this transport has
347 * Interpretation: more is better
350 * LAN: 12,800 (100 MBit/s)
351 * WLAN: 6,912 (54 MBit/s)
352 * Dial-up: 8 (64 Kbit/s)
355 // GNUNET_ATS_COST_BANDWITH_AVAILABLE = 6,
359 * How many bytes are sent over the wire when 1 kilobyte (1024 bytes)
360 * of application data is transmitted?
361 * A factor used with connect cost, bandwidth cost and energy cost
362 * to describe the overhead produced by the transport protocol
366 * Interpretation: less is better
370 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
371 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
372 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
373 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
375 // GNUNET_ATS_COST_NETWORK_OVERHEAD = 7,
376 /* Quality related values */
377 /* ====================== */
378 /* Physical layer quality properties */
380 * Signal strength on physical layer
384 // GNUNET_ATS_QUALITY_PHY_SIGNAL_STRENGTH = 1025,
386 * Collision rate on physical layer
390 // GNUNET_ATS_QUALITY_PHY_COLLISION_RATE = 1026,
392 * Error rate on physical layer
396 // GNUNET_ATS_QUALITY_PHY_ERROR_RATE = 1027,
399 * Time variations of the delay
400 * 1st derivative of a delay function
404 // GNUNET_ATS_QUALITY_NET_JITTER = 1029,
406 * Error rate on network layer
415 * Note: This numbers are just assumptions as an example, not
416 * measured or somehow determined
418 // GNUNET_ATS_QUALITY_NET_ERRORRATE = 1030,
420 * Drop rate on network layer
421 * Bytes actively dismissed by a network component during transmission
422 * Reasons for dropped data can be full queues, congestion, quota violations...
431 * Note: This numbers are just assumptions as an example, not
432 * measured or somehow determined
434 // GNUNET_ATS_QUALITY_NET_DROPRATE = 1031,
436 * Loss rate on network layer
437 * Bytes lost during transmission
438 * Reasons can be collisions, ...
447 * Note: This numbers are just assumptions as an example, not measured
448 * or somehow determined
450 // GNUNET_ATS_QUALITY_NET_LOSSRATE = 1032,
452 * Throughput on network layer
463 // GNUNET_ATS_QUALITY_NET_THROUGHPUT = 1033,
464 /* Availability related values */
465 /* =========================== */
467 * Is a peer reachable?
469 // GNUNET_ATS_AVAILABILITY_REACHABLE = 2048,
471 * Is there a connection established to a peer using this transport
473 // GNUNET_ATS_AVAILABILITY_CONNECTED = 2049
477 * Number of ATS quality properties
479 #define GNUNET_ATS_QualityPropertiesCount 2
482 * ATS quality properties as array initializer
484 #define GNUNET_ATS_QualityProperties {GNUNET_ATS_QUALITY_NET_DELAY, GNUNET_ATS_QUALITY_NET_DISTANCE}
487 * ATS quality properties as string array initializer
489 #define GNUNET_ATS_QualityPropertiesString {"Delay", "Distance"}
491 GNUNET_NETWORK_STRUCT_BEGIN
494 * struct used to communicate the transport's properties like cost and
495 * quality of service as well as high-level constraints on resource
499 * +-----------+ Constraints | | Plugin properties +---------+
500 * | Highlevel |------------> |ATS| <------------------|Transport|
501 * | Component | ATS struct | | ATS struct | Plugin |
502 * +-----------+ | | +---------+
505 * This structure will be used by transport plugins to communicate
506 * costs to ATS or by higher level components to tell ATS their
507 * constraints. Always a pair of (GNUNET_ATS_Property,
508 * uint32_t value). Value is always uint32_t, so all units used to
509 * define costs have to be normalized to fit uint32_t.
511 struct GNUNET_ATS_Information
514 * ATS property type, in network byte order.
516 uint32_t type GNUNET_PACKED;
519 * ATS property value, in network byte order.
521 uint32_t value GNUNET_PACKED;
523 GNUNET_NETWORK_STRUCT_END
525 /* ******************************** Scheduling API ***************************** */
528 * Handle to the ATS subsystem for bandwidth/transport scheduling information.
530 struct GNUNET_ATS_SchedulingHandle;
533 * Handle for address suggestion requests
535 struct GNUNET_ATS_SuggestHandle;
538 * Opaque session handle, defined by plugins. Contents not known to ATS.
543 * Signature of a function called by ATS with the current bandwidth
544 * and address preferences as determined by ATS.
546 * If an address is available immediately the address will be included. If no
547 * address can be suggested, address, session, bandwidth and ATS information will
548 * be NULL/0. ATS will suggest an address as soon as it can provide such an
552 * @param address suggested address (including peer identity of the peer)
553 * @param session session to use
554 * @param bandwidth_out assigned outbound bandwidth for the connection
555 * @param bandwidth_in assigned inbound bandwidth for the connection
556 * @param ats performance data for the address (as far as known)
557 * @param ats_count number of performance records in @a ats
560 (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
561 const struct GNUNET_PeerIdentity *peer,
562 const struct GNUNET_HELLO_Address *address, struct Session *session,
563 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
564 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
565 const struct GNUNET_ATS_Information *ats, uint32_t ats_count);
569 * Initialize the ATS subsystem.
571 * @param cfg configuration to use
572 * @param suggest_cb notification to call whenever the suggestation changed
573 * @param suggest_cb_cls closure for 'suggest_cb'
574 * @return ats context
576 struct GNUNET_ATS_SchedulingHandle *
577 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
578 GNUNET_ATS_AddressSuggestionCallback suggest_cb, void *suggest_cb_cls);
581 * Client is done with ATS scheduling, release resources.
583 * @param sh handle to release
586 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
589 * We would like to reset the address suggestion block time for this
593 * @param peer identity of the peer we want to reset
596 GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
597 const struct GNUNET_PeerIdentity *peer);
601 * We would like to establish a new connection with a peer. ATS
602 * should suggest a good address to begin with.
605 * @param peer identity of the peer we need an address for
606 * @param cont the continuation to indicate success to call with the address
607 * @param cont_cls the cls for the continuation
608 * @return suggestion handle
610 struct GNUNET_ATS_SuggestHandle *
611 GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
612 const struct GNUNET_PeerIdentity *peer,
613 GNUNET_ATS_AddressSuggestionCallback cont,
618 * We want to cancel ATS suggesting addresses for a peer.
621 * @param peer identity of the peer
624 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SchedulingHandle *sh,
625 const struct GNUNET_PeerIdentity *peer);
629 * Convert a ATS property to a string
631 * @param type the atsi type
632 * @return a string or NULL if invalid
635 GNUNET_ATS_print_property_type (uint32_t type);
639 * Convert a GNUNET_ATS_NetworkType to a string
641 * @param net the network type
642 * @return a string or NULL if invalid
645 GNUNET_ATS_print_network_type (uint32_t net);
649 * Returns where the address is located: LAN or WAN or ...
650 * @param sh the GNUNET_ATS_SchedulingHandle handle
651 * @param addr address
652 * @param addrlen address length
653 * @return location as GNUNET_ATS_Information
655 struct GNUNET_ATS_Information
656 GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle *sh,
657 const struct sockaddr * addr,
662 * Test if a address and a session is known to ATS
664 * @param sh the scheduling handle
665 * @param address the address
666 * @param session the session
667 * @return #GNUNET_YES or #GNUNET_NO
670 GNUNET_ATS_session_known (struct GNUNET_ATS_SchedulingHandle *sh,
671 const struct GNUNET_HELLO_Address *address,
672 struct Session *session);
676 * We have a new address ATS should know. Addresses have to be added with this
677 * function before they can be: updated, set in use and destroyed
680 * @param address the address
681 * @param session session handle (if available)
682 * @param ats performance data for the address
683 * @param ats_count number of performance records in @a ats
686 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
687 const struct GNUNET_HELLO_Address *address,
688 struct Session *session,
689 const struct GNUNET_ATS_Information *ats,
694 * We have updated performance statistics for a given address. Note
695 * that this function can be called for addresses that are currently
696 * in use as well as addresses that are valid but not actively in use.
697 * Furthermore, the peer may not even be connected to us right now (in
698 * which case the call may be ignored or the information may be stored
699 * for later use). Update bandwidth assignments.
702 * @param address updated address
703 * @param session session handle (if available)
704 * @param ats performance data for the address
705 * @param ats_count number of performance records in @a ats
706 * @return #GNUNET_OK or #GNUNET_SYSERR
709 GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
710 const struct GNUNET_HELLO_Address *address,
711 struct Session *session,
712 const struct GNUNET_ATS_Information *ats,
717 * An address is now in use or not used any more.
720 * @param address the address
721 * @param session session handle
722 * @param in_use #GNUNET_YES if this address is now used, #GNUNET_NO
723 * if address is not used any more
726 GNUNET_ATS_address_in_use (struct GNUNET_ATS_SchedulingHandle *sh,
727 const struct GNUNET_HELLO_Address *address,
728 struct Session *session,
733 * An address got destroyed, stop including it as a valid address.
735 * If a session is given, only the session will be removed, if no session is
736 * given the full address will be deleted.
739 * @param address the address
740 * @param session session handle that is no longer valid (if available)
743 GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
744 const struct GNUNET_HELLO_Address *address,
745 struct Session *session);
748 /* ******************************** Performance API ***************************** */
751 * ATS Handle to obtain and/or modify performance information.
753 struct GNUNET_ATS_PerformanceHandle;
756 * Signature of a function that is called with QoS information about an address.
759 * @param address the address
760 * @param address_active is this address actively used to maintain a connection
762 * @param bandwidth_out assigned outbound bandwidth for the connection
763 * @param bandwidth_in assigned inbound bandwidth for the connection
764 * @param ats performance data for the address (as far as known)
765 * @param ats_count number of performance records in 'ats'
768 (*GNUNET_ATS_AddressInformationCallback) (void *cls,
769 const struct GNUNET_HELLO_Address *address, int address_active,
770 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
771 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
772 const struct GNUNET_ATS_Information *ats, uint32_t ats_count);
775 * Handle for an address listing operation
777 struct GNUNET_ATS_AddressListHandle;
780 * Get handle to access performance API of the ATS subsystem.
782 * @param cfg configuration to use
783 * @param addr_info_cb callback called when performance characteristics for
785 * @param addr_info_cb_cls closure for infocb
786 * @return ats performance context
788 struct GNUNET_ATS_PerformanceHandle *
789 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
790 GNUNET_ATS_AddressInformationCallback addr_info_cb, void *addr_info_cb_cls);
793 * Get information about addresses known to the ATS subsystem.
795 * @param handle the performance handle to use
796 * @param peer peer idm can be NULL for all peers
797 * @param all GNUNET_YES to get information about all addresses or GNUNET_NO to
798 * get only address currently used
799 * @param infocb callback to call with the addresses,
800 * will callback with address == NULL when done
801 * @param infocb_cls closure for infocb
802 * @return ats performance context
804 struct GNUNET_ATS_AddressListHandle *
805 GNUNET_ATS_performance_list_addresses (
806 struct GNUNET_ATS_PerformanceHandle *handle,
807 const struct GNUNET_PeerIdentity *peer, int all,
808 GNUNET_ATS_AddressInformationCallback infocb, void *infocb_cls);
811 * Cancel a pending address listing operation
813 * @param handle the GNUNET_ATS_AddressListHandle handle to cancel
816 GNUNET_ATS_performance_list_addresses_cancel (
817 struct GNUNET_ATS_AddressListHandle *handle);
820 * Client is done using the ATS performance subsystem, release resources.
825 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph);
828 * Function called with reservation result.
831 * @param peer identifies the peer
832 * @param amount set to the amount that was actually reserved or unreserved;
833 * either the full requested amount or zero (no partial reservations)
834 * @param res_delay if the reservation could not be satisfied (amount was 0), how
835 * long should the client wait until re-trying?
838 (*GNUNET_ATS_ReservationCallback) (void *cls,
839 const struct GNUNET_PeerIdentity * peer, int32_t amount,
840 struct GNUNET_TIME_Relative res_delay);
843 * Context that can be used to cancel a peer information request.
845 struct GNUNET_ATS_ReservationContext;
848 * Reserve inbound bandwidth from the given peer. ATS will look at
849 * the current amount of traffic we receive from the peer and ensure
850 * that the peer could add 'amount' of data to its stream.
852 * @param ph performance handle
853 * @param peer identifies the peer
854 * @param amount reserve N bytes for receiving, negative
855 * amounts can be used to undo a (recent) reservation;
856 * @param rcb function to call with the resulting reservation information
857 * @param rcb_cls closure for info
858 * @return NULL on error
859 * @deprecated will be replaced soon
861 struct GNUNET_ATS_ReservationContext *
862 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
863 const struct GNUNET_PeerIdentity *peer, int32_t amount,
864 GNUNET_ATS_ReservationCallback rcb, void *rcb_cls);
867 * Cancel request for reserving bandwidth.
869 * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
872 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
875 * Number of preference types supported by ATS
877 #define GNUNET_ATS_PreferenceCount 3
880 * ATS preference types as array initializer
882 #define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_END, GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY}
885 * ATS preference types as string array initializer
887 #define GNUNET_ATS_PreferenceTypeString {"END", "BANDWIDTH", "LATENCY"}
890 * Enum defining all known preference categories.
892 enum GNUNET_ATS_PreferenceKind
896 * End of preference list.
898 GNUNET_ATS_PREFERENCE_END = 0,
901 * Change the peer's bandwidth value (value per byte of bandwidth in
902 * the goal function) to the given amount. The argument is followed
903 * by a double value giving the desired value (can be negative).
904 * Preference changes are forgotten if peers disconnect.
906 GNUNET_ATS_PREFERENCE_BANDWIDTH,
909 * Change the peer's latency value to the given amount. The
910 * argument is followed by a double value giving the desired value
911 * (can be negative). The absolute score in the goal function is
912 * the inverse of the latency in microseconds (minimum: 1
913 * microsecond) multiplied by the latency preferences.
915 GNUNET_ATS_PREFERENCE_LATENCY
919 * Convert a GNUNET_ATS_PreferenceType to a string
921 * @param type the preference type
922 * @return a string or NULL if invalid
925 GNUNET_ATS_print_preference_type (uint32_t type);
928 * Change preferences for the given peer. Preference changes are forgotten if peers
931 * @param ph performance handle
932 * @param peer identifies the peer
933 * @param ... 0-terminated specification of the desired changes
936 GNUNET_ATS_performance_change_preference (
937 struct GNUNET_ATS_PerformanceHandle *ph,
938 const struct GNUNET_PeerIdentity *peer, ...);
941 * Application feedback on how good preference requirements are fulfilled
942 * for the preferences included in the given time scope [now - scope .. now]
944 * An application notifies ATS if (and only if) it has feedback information
945 * for specific properties. This values are valid until the feedback scores are
946 * updated by the application.
948 * If the application has no feedback for this preference kind the application
949 * will not explicitly call for this property and will not include it in this
952 * @param ph performance handle
953 * @param scope the time interval this valid for: [now - scope .. now]
954 * @param peer identifies the peer
955 * @param ... 0-terminated specification of the desired changes
958 GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
959 const struct GNUNET_PeerIdentity *peer,
960 const struct GNUNET_TIME_Relative scope, ...);
963 /* end of file gnunet-service-transport_ats.h */