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
27 * - move GNUNET_TRANSPORT_ATS* in here and rename...
28 * - extend API to express communication preferences to ATS
29 * (to be called DIRECTLY from apps, not from transport/core!)
31 #ifndef GNUNET_ATS_SERVICE_H
32 #define GNUNET_ATS_SERVICE_H
34 #include "gnunet_constants.h"
35 #include "gnunet_util_lib.h"
36 #include "gnunet_transport_service.h"
37 #include "gnunet_transport_plugin.h"
41 * Handle to the ATS subsystem.
43 struct GNUNET_ATS_Handle;
47 * Signature of a function called by ATS to notify the callee that the
48 * assigned bandwidth or address for a given peer was changed. If the
49 * callback is called with address/bandwidth assignments of zero, the
50 * ATS disconnect function will still be called once the disconnect
54 * @param peer identity of the peer
55 * @param plugin_name name of the transport plugin, NULL to disconnect
56 * @param session session to use (if available)
57 * @param plugin_addr address to use (if available)
58 * @param plugin_addr_len number of bytes in addr
59 * @param bandwidth assigned outbound bandwidth for the connection
61 typedef void (*GNUNET_TRANSPORT_ATS_AllocationNotification) (void *cls,
74 GNUNET_BANDWIDTH_Value32NBO
79 * Initialize the ATS subsystem.
81 * @param cfg configuration to use
82 * @param alloc_cb notification to call whenever the allocation changed
83 * @param alloc_cb_cls closure for 'alloc_cb'
86 struct GNUNET_ATS_Handle *GNUNET_ATS_init (const struct
87 GNUNET_CONFIGURATION_Handle *cfg,
88 GNUNET_TRANSPORT_ATS_AllocationNotification
89 alloc_cb, void *alloc_cb_cls);
93 * Shutdown the ATS subsystem.
97 void GNUNET_ATS_shutdown (struct GNUNET_ATS_Handle *atc);
101 * Signature of a function that takes an address suggestion
104 * @param peer identity of the new peer
105 * @param plugin_name name of the plugin, NULL if we have no suggestion
106 * @param plugin_addr suggested address, NULL if we have no suggestion
107 * @param plugin_addr_len number of bytes in plugin_addr
108 * @param bandwidth assigned outbound bandwidth for the connection
109 * @param ats performance data for the address (as far as known)
110 * @param ats_count number of performance records in 'ats'
112 typedef void (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
114 GNUNET_PeerIdentity *
116 const char *plugin_name,
117 const void *plugin_addr,
118 size_t plugin_addr_len,
120 GNUNET_BANDWIDTH_Value32NBO
123 GNUNET_TRANSPORT_ATS_Information
129 * Handle to cancel suggestion request.
131 struct GNUNET_ATS_SuggestionContext;
135 * We would like to establish a new connection with a peer.
136 * ATS should suggest a good address to begin with.
139 * @param peer identity of the new peer
140 * @param cb function to call with the address
141 * @param cb_cls closure for cb
143 struct GNUNET_ATS_SuggestionContext *GNUNET_ATS_suggest_address (struct
149 GNUNET_ATS_AddressSuggestionCallback
155 * Cancel suggestion request.
157 * @param asc handle of the request to cancel
160 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SuggestionContext *asc);
164 * We established a new connection with a peer (for example, because
165 * core asked for it or because the other peer connected to us).
166 * Calculate bandwidth assignments including the new peer.
169 * @param peer identity of the new peer
170 * @param plugin_name name of the currently used transport plugin
171 * @param session session in use (if available)
172 * @param plugin_addr address in use (if available)
173 * @param plugin_addr_len number of bytes in plugin_addr
174 * @param ats performance data for the connection
175 * @param ats_count number of performance records in 'ats'
178 GNUNET_ATS_peer_connect (struct GNUNET_ATS_Handle *atc,
179 const struct GNUNET_PeerIdentity *peer,
180 const char *plugin_name,
181 struct Session *session,
182 const void *plugin_addr,
183 size_t plugin_addr_len,
184 const struct GNUNET_TRANSPORT_ATS_Information *ats,
189 * We disconnected from the given peer (for example, because ats, core
190 * or blacklist asked for it or because the other peer disconnected).
191 * Calculate bandwidth assignments without the peer.
194 * @param peer identity of the peer
197 GNUNET_ATS_peer_disconnect (struct GNUNET_ATS_Handle *atc,
198 const struct GNUNET_PeerIdentity *peer);
202 * A session got destroyed, stop including it as a valid address.
205 * @param peer identity of the peer
206 * @param session session handle that is no longer valid
209 GNUNET_ATS_session_destroyed (struct GNUNET_ATS_Handle *atc,
210 const struct GNUNET_PeerIdentity *peer,
211 const struct Session *session);
215 * We have updated performance statistics for a given address. Note
216 * that this function can be called for addresses that are currently
217 * in use as well as addresses that are valid but not actively in use.
218 * Furthermore, the peer may not even be connected to us right now (in
219 * which case the call may be ignored or the information may be stored
220 * for later use). Update bandwidth assignments.
223 * @param peer identity of the new peer
224 * @param valid_until how long is the address valid?
225 * @param plugin_name name of the transport plugin
226 * @param session session handle (if available)
227 * @param plugin_addr address (if available)
228 * @param plugin_addr_len number of bytes in plugin_addr
229 * @param ats performance data for the address
230 * @param ats_count number of performance records in 'ats'
233 GNUNET_ATS_address_update (struct GNUNET_ATS_Handle *atc,
234 const struct GNUNET_PeerIdentity *peer,
235 struct GNUNET_TIME_Absolute valid_until,
236 const char *plugin_name,
237 struct Session *session,
238 const void *plugin_addr,
239 size_t plugin_addr_len,
240 const struct GNUNET_TRANSPORT_ATS_Information *ats,
245 /* end of file gnunet-service-transport_ats.h */