aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_ats_service.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2014-06-16 07:58:28 +0000
committerChristian Grothoff <christian@grothoff.org>2014-06-16 07:58:28 +0000
commit2c8688f023c99960394e066a30a3eed4041f43fb (patch)
treea5da5beebe1b9104caf2077f3d1998bf67f380ea /src/include/gnunet_ats_service.h
parentca86c832ab602853100a7e0c559aacd162046678 (diff)
downloadgnunet-2c8688f023c99960394e066a30a3eed4041f43fb.tar.gz
gnunet-2c8688f023c99960394e066a30a3eed4041f43fb.zip
-doxygen, indentation
Diffstat (limited to 'src/include/gnunet_ats_service.h')
-rw-r--r--src/include/gnunet_ats_service.h37
1 files changed, 24 insertions, 13 deletions
diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h
index eeb9eec38..18c338c2c 100644
--- a/src/include/gnunet_ats_service.h
+++ b/src/include/gnunet_ats_service.h
@@ -570,13 +570,14 @@ typedef void
570 * 570 *
571 * @param cfg configuration to use 571 * @param cfg configuration to use
572 * @param suggest_cb notification to call whenever the suggestation changed 572 * @param suggest_cb notification to call whenever the suggestation changed
573 * @param suggest_cb_cls closure for 'suggest_cb' 573 * @param suggest_cb_cls closure for @a suggest_cb
574 * @return ats context 574 * @return ats context
575 */ 575 */
576struct GNUNET_ATS_SchedulingHandle * 576struct GNUNET_ATS_SchedulingHandle *
577GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg, 577GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
578 GNUNET_ATS_AddressSuggestionCallback suggest_cb, void *suggest_cb_cls); 578 GNUNET_ATS_AddressSuggestionCallback suggest_cb, void *suggest_cb_cls);
579 579
580
580/** 581/**
581 * Client is done with ATS scheduling, release resources. 582 * Client is done with ATS scheduling, release resources.
582 * 583 *
@@ -585,6 +586,7 @@ GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
585void 586void
586GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh); 587GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
587 588
589
588/** 590/**
589 * We would like to reset the address suggestion block time for this 591 * We would like to reset the address suggestion block time for this
590 * peer 592 * peer
@@ -604,7 +606,7 @@ GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
604 * @param sh handle 606 * @param sh handle
605 * @param peer identity of the peer we need an address for 607 * @param peer identity of the peer we need an address for
606 * @param cont the continuation to indicate success to call with the address 608 * @param cont the continuation to indicate success to call with the address
607 * @param cont_cls the cls for the continuation 609 * @param cont_cls the closure for the @a cont
608 * @return suggestion handle 610 * @return suggestion handle
609 */ 611 */
610struct GNUNET_ATS_SuggestHandle * 612struct GNUNET_ATS_SuggestHandle *
@@ -647,10 +649,10 @@ GNUNET_ATS_print_network_type (uint32_t net);
647 649
648/** 650/**
649 * Returns where the address is located: LAN or WAN or ... 651 * Returns where the address is located: LAN or WAN or ...
650 * @param sh the GNUNET_ATS_SchedulingHandle handle 652 * @param sh the `struct GNUNET_ATS_SchedulingHandle` handle
651 * @param addr address 653 * @param addr address
652 * @param addrlen address length 654 * @param addrlen address length
653 * @return location as GNUNET_ATS_Information 655 * @return location as `struct GNUNET_ATS_Information`
654 */ 656 */
655struct GNUNET_ATS_Information 657struct GNUNET_ATS_Information
656GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle *sh, 658GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle *sh,
@@ -762,7 +764,7 @@ struct GNUNET_ATS_PerformanceHandle;
762 * @param bandwidth_out assigned outbound bandwidth for the connection 764 * @param bandwidth_out assigned outbound bandwidth for the connection
763 * @param bandwidth_in assigned inbound bandwidth for the connection 765 * @param bandwidth_in assigned inbound bandwidth for the connection
764 * @param ats performance data for the address (as far as known) 766 * @param ats performance data for the address (as far as known)
765 * @param ats_count number of performance records in 'ats' 767 * @param ats_count number of performance records in @a ats
766 */ 768 */
767typedef void 769typedef void
768(*GNUNET_ATS_AddressInformationCallback) (void *cls, 770(*GNUNET_ATS_AddressInformationCallback) (void *cls,
@@ -778,18 +780,21 @@ typedef void
778 */ 780 */
779struct GNUNET_ATS_AddressListHandle; 781struct GNUNET_ATS_AddressListHandle;
780 782
783
781/** 784/**
782 * Get handle to access performance API of the ATS subsystem. 785 * Get handle to access performance API of the ATS subsystem.
783 * 786 *
784 * @param cfg configuration to use 787 * @param cfg configuration to use
785 * @param addr_info_cb callback called when performance characteristics for 788 * @param addr_info_cb callback called when performance characteristics for
786 * an address change 789 * an address change
787 * @param addr_info_cb_cls closure for infocb 790 * @param addr_info_cb_cls closure for @a addr_info_cb
788 * @return ats performance context 791 * @return ats performance context
789 */ 792 */
790struct GNUNET_ATS_PerformanceHandle * 793struct GNUNET_ATS_PerformanceHandle *
791GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg, 794GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
792 GNUNET_ATS_AddressInformationCallback addr_info_cb, void *addr_info_cb_cls); 795 GNUNET_ATS_AddressInformationCallback addr_info_cb,
796 void *addr_info_cb_cls);
797
793 798
794/** 799/**
795 * Get information about addresses known to the ATS subsystem. 800 * Get information about addresses known to the ATS subsystem.
@@ -809,14 +814,15 @@ GNUNET_ATS_performance_list_addresses (
809 const struct GNUNET_PeerIdentity *peer, int all, 814 const struct GNUNET_PeerIdentity *peer, int all,
810 GNUNET_ATS_AddressInformationCallback infocb, void *infocb_cls); 815 GNUNET_ATS_AddressInformationCallback infocb, void *infocb_cls);
811 816
817
812/** 818/**
813 * Cancel a pending address listing operation 819 * Cancel a pending address listing operation
814 * 820 *
815 * @param handle the GNUNET_ATS_AddressListHandle handle to cancel 821 * @param handle the `struct GNUNET_ATS_AddressListHandle` handle to cancel
816 */ 822 */
817void 823void
818GNUNET_ATS_performance_list_addresses_cancel ( 824GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle);
819 struct GNUNET_ATS_AddressListHandle *handle); 825
820 826
821/** 827/**
822 * Client is done using the ATS performance subsystem, release resources. 828 * Client is done using the ATS performance subsystem, release resources.
@@ -826,6 +832,7 @@ GNUNET_ATS_performance_list_addresses_cancel (
826void 832void
827GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph); 833GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph);
828 834
835
829/** 836/**
830 * Function called with reservation result. 837 * Function called with reservation result.
831 * 838 *
@@ -841,11 +848,13 @@ typedef void
841 const struct GNUNET_PeerIdentity * peer, int32_t amount, 848 const struct GNUNET_PeerIdentity * peer, int32_t amount,
842 struct GNUNET_TIME_Relative res_delay); 849 struct GNUNET_TIME_Relative res_delay);
843 850
851
844/** 852/**
845 * Context that can be used to cancel a peer information request. 853 * Context that can be used to cancel a peer information request.
846 */ 854 */
847struct GNUNET_ATS_ReservationContext; 855struct GNUNET_ATS_ReservationContext;
848 856
857
849/** 858/**
850 * Reserve inbound bandwidth from the given peer. ATS will look at 859 * Reserve inbound bandwidth from the given peer. ATS will look at
851 * the current amount of traffic we receive from the peer and ensure 860 * the current amount of traffic we receive from the peer and ensure
@@ -865,6 +874,7 @@ GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
865 const struct GNUNET_PeerIdentity *peer, int32_t amount, 874 const struct GNUNET_PeerIdentity *peer, int32_t amount,
866 GNUNET_ATS_ReservationCallback rcb, void *rcb_cls); 875 GNUNET_ATS_ReservationCallback rcb, void *rcb_cls);
867 876
877
868/** 878/**
869 * Cancel request for reserving bandwidth. 879 * Cancel request for reserving bandwidth.
870 * 880 *
@@ -926,6 +936,7 @@ enum GNUNET_ATS_PreferenceKind
926const char * 936const char *
927GNUNET_ATS_print_preference_type (uint32_t type); 937GNUNET_ATS_print_preference_type (uint32_t type);
928 938
939
929/** 940/**
930 * Change preferences for the given peer. Preference changes are forgotten if peers 941 * Change preferences for the given peer. Preference changes are forgotten if peers
931 * disconnect. 942 * disconnect.
@@ -935,9 +946,9 @@ GNUNET_ATS_print_preference_type (uint32_t type);
935 * @param ... 0-terminated specification of the desired changes 946 * @param ... 0-terminated specification of the desired changes
936 */ 947 */
937void 948void
938GNUNET_ATS_performance_change_preference ( 949GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
939 struct GNUNET_ATS_PerformanceHandle *ph, 950 const struct GNUNET_PeerIdentity *peer, ...);
940 const struct GNUNET_PeerIdentity *peer, ...); 951
941 952
942/** 953/**
943 * Application feedback on how good preference requirements are fulfilled 954 * Application feedback on how good preference requirements are fulfilled