diff options
author | Matthias Wachs <wachs@net.in.tum.de> | 2013-10-09 07:33:47 +0000 |
---|---|---|
committer | Matthias Wachs <wachs@net.in.tum.de> | 2013-10-09 07:33:47 +0000 |
commit | c3232fbe508dfbb9b7e062abee9f73dc6aa40082 (patch) | |
tree | d7910e97b112fc3b2c25d447d65960bc8379966d /src/include/gnunet_ats_plugin.h | |
parent | 50f061e6ca2df0c9473b87f79beb5225b1400f03 (diff) | |
download | gnunet-c3232fbe508dfbb9b7e062abee9f73dc6aa40082.tar.gz gnunet-c3232fbe508dfbb9b7e062abee9f73dc6aa40082.zip |
documentation and fix for const warning
Diffstat (limited to 'src/include/gnunet_ats_plugin.h')
-rw-r--r-- | src/include/gnunet_ats_plugin.h | 77 |
1 files changed, 70 insertions, 7 deletions
diff --git a/src/include/gnunet_ats_plugin.h b/src/include/gnunet_ats_plugin.h index e6c22d3c8..c9dfd8e39 100644 --- a/src/include/gnunet_ats_plugin.h +++ b/src/include/gnunet_ats_plugin.h | |||
@@ -291,9 +291,9 @@ typedef const double * | |||
291 | 291 | ||
292 | 292 | ||
293 | /** | 293 | /** |
294 | * The transport service will pass a pointer to a struct | 294 | * The ATS service will pass a pointer to a struct |
295 | * of this type as the first and only argument to the | 295 | * of this type as the first and only argument to the |
296 | * entry point of each transport plugin. | 296 | * entry point of each ATS solver. |
297 | */ | 297 | */ |
298 | struct GNUNET_ATS_PluginEnvironment | 298 | struct GNUNET_ATS_PluginEnvironment |
299 | { | 299 | { |
@@ -302,26 +302,89 @@ struct GNUNET_ATS_PluginEnvironment | |||
302 | */ | 302 | */ |
303 | void *cls; | 303 | void *cls; |
304 | 304 | ||
305 | |||
306 | /** | ||
307 | * Configuration handle to be used by the solver | ||
308 | */ | ||
309 | const struct GNUNET_CONFIGURATION_Handle *cfg; | ||
310 | |||
311 | |||
312 | /** | ||
313 | * Statistics handle to be used by the solver | ||
314 | */ | ||
315 | const struct GNUNET_STATISTICS_Handle *stats; | ||
316 | |||
317 | |||
318 | /** | ||
319 | * Hashmap containing all addresses available | ||
320 | */ | ||
321 | struct GNUNET_CONTAINER_MultiPeerMap *addresses; | ||
322 | |||
323 | |||
324 | /** | ||
325 | * ATS addresses callback to be notified about bandwidth assignment changes | ||
326 | */ | ||
305 | GAS_bandwidth_changed_cb bandwidth_changed_cb; | 327 | GAS_bandwidth_changed_cb bandwidth_changed_cb; |
328 | |||
329 | |||
330 | /** | ||
331 | * ATS addresses closure to be notified about bandwidth assignment changes | ||
332 | */ | ||
306 | void *bw_changed_cb_cls; | 333 | void *bw_changed_cb_cls; |
307 | 334 | ||
308 | GAS_get_preferences get_preferences_cb; | 335 | |
336 | /** | ||
337 | * ATS addresses function to obtain preference values | ||
338 | */ | ||
339 | GAS_get_preferences get_preferences; | ||
340 | |||
341 | |||
342 | /** | ||
343 | * ATS addresses function closure to obtain preference values | ||
344 | */ | ||
309 | void *get_preference_cls; | 345 | void *get_preference_cls; |
310 | 346 | ||
347 | /** | ||
348 | * ATS addresses function to obtain property values | ||
349 | */ | ||
311 | GAS_get_properties get_property_cb; | 350 | GAS_get_properties get_property_cb; |
351 | |||
352 | |||
353 | /** | ||
354 | * ATS addresses function closure to obtain property values | ||
355 | */ | ||
312 | void *get_property_cls; | 356 | void *get_property_cls; |
313 | 357 | ||
358 | |||
359 | /** | ||
360 | * The ATS solver plugin functions to call | ||
361 | */ | ||
314 | struct GNUNET_ATS_SolverFunctions sf; | 362 | struct GNUNET_ATS_SolverFunctions sf; |
315 | 363 | ||
316 | struct GNUNET_CONFIGURATION_Handle *cfg; | ||
317 | struct GNUNET_STATISTICS_Handle *stats; | ||
318 | struct GNUNET_CONTAINER_MultiPeerMap *addresses; | ||
319 | 364 | ||
320 | /* Available networks */ | 365 | /** |
366 | * Available networks | ||
367 | */ | ||
321 | int networks[GNUNET_ATS_NetworkTypeCount]; | 368 | int networks[GNUNET_ATS_NetworkTypeCount]; |
369 | |||
370 | |||
371 | /** | ||
372 | * Number of networks available | ||
373 | */ | ||
322 | int network_count; | 374 | int network_count; |
323 | 375 | ||
376 | |||
377 | /** | ||
378 | * Array of configured outbound quotas | ||
379 | * Order according to networks in network array | ||
380 | */ | ||
324 | unsigned long long out_quota[GNUNET_ATS_NetworkTypeCount]; | 381 | unsigned long long out_quota[GNUNET_ATS_NetworkTypeCount]; |
382 | |||
383 | |||
384 | /** | ||
385 | * Array of configured inbound quotas | ||
386 | * Order according to networks in network array | ||
387 | */ | ||
325 | unsigned long long in_quota[GNUNET_ATS_NetworkTypeCount]; | 388 | unsigned long long in_quota[GNUNET_ATS_NetworkTypeCount]; |
326 | }; | 389 | }; |
327 | 390 | ||