summaryrefslogtreecommitdiff
path: root/src/ats/ats.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/ats/ats.h')
-rw-r--r--src/ats/ats.h45
1 files changed, 30 insertions, 15 deletions
diff --git a/src/ats/ats.h b/src/ats/ats.h
index 3501860f3..3a3d12cfa 100644
--- a/src/ats/ats.h
+++ b/src/ats/ats.h
@@ -34,7 +34,8 @@
34 * Flag used to indicate which type of client is connecting 34 * Flag used to indicate which type of client is connecting
35 * to the ATS service. 35 * to the ATS service.
36 */ 36 */
37enum StartFlag { 37enum StartFlag
38{
38 /** 39 /**
39 * This is a scheduling client (aka transport service) 40 * This is a scheduling client (aka transport service)
40 */ 41 */
@@ -65,7 +66,8 @@ GNUNET_NETWORK_STRUCT_BEGIN
65 * First message any client sends to ATS, used to self-identify 66 * First message any client sends to ATS, used to self-identify
66 * (what type of client this is). 67 * (what type of client this is).
67 */ 68 */
68struct ClientStartMessage { 69struct ClientStartMessage
70{
69 /** 71 /**
70 * Type is #GNUNET_MESSAGE_TYPE_ATS_START. 72 * Type is #GNUNET_MESSAGE_TYPE_ATS_START.
71 */ 73 */
@@ -82,7 +84,8 @@ struct ClientStartMessage {
82 * Connectivity client to ATS service: we would like to have 84 * Connectivity client to ATS service: we would like to have
83 * address suggestions for this peer. 85 * address suggestions for this peer.
84 */ 86 */
85struct RequestAddressMessage { 87struct RequestAddressMessage
88{
86 /** 89 /**
87 * Type is #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS or 90 * Type is #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS or
88 * #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL to stop 91 * #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL to stop
@@ -105,7 +108,8 @@ struct RequestAddressMessage {
105/** 108/**
106 * Scheduling client to ATS service: here is another address you can use. 109 * Scheduling client to ATS service: here is another address you can use.
107 */ 110 */
108struct AddressAddMessage { 111struct AddressAddMessage
112{
109 /** 113 /**
110 * Type is #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD. 114 * Type is #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD.
111 */ 115 */
@@ -154,7 +158,8 @@ struct AddressAddMessage {
154 * Message used to notify ATS that the performance 158 * Message used to notify ATS that the performance
155 * characteristics for an address have changed. 159 * characteristics for an address have changed.
156 */ 160 */
157struct AddressUpdateMessage { 161struct AddressUpdateMessage
162{
158 /** 163 /**
159 * Message of type #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE. 164 * Message of type #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE.
160 */ 165 */
@@ -184,7 +189,8 @@ struct AddressUpdateMessage {
184 * was destroyed and must thus henceforth no longer be considered 189 * was destroyed and must thus henceforth no longer be considered
185 * for scheduling. 190 * for scheduling.
186 */ 191 */
187struct AddressDestroyedMessage { 192struct AddressDestroyedMessage
193{
188 /** 194 /**
189 * Type is #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED. 195 * Type is #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED.
190 */ 196 */
@@ -208,7 +214,8 @@ struct AddressDestroyedMessage {
208 * Message sent by ATS service to client to confirm that it is done 214 * Message sent by ATS service to client to confirm that it is done
209 * using the given session ID. 215 * using the given session ID.
210 */ 216 */
211struct GNUNET_ATS_SessionReleaseMessage { 217struct GNUNET_ATS_SessionReleaseMessage
218{
212 /** 219 /**
213 * Type is #GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE. 220 * Type is #GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE.
214 */ 221 */
@@ -234,7 +241,8 @@ struct GNUNET_ATS_SessionReleaseMessage {
234 * identified by the given @e session_id for the given @e peer with 241 * identified by the given @e session_id for the given @e peer with
235 * the given @e bandwidth_in and @e bandwidth_out limits from now on. 242 * the given @e bandwidth_in and @e bandwidth_out limits from now on.
236 */ 243 */
237struct AddressSuggestionMessage { 244struct AddressSuggestionMessage
245{
238 /** 246 /**
239 * A message of type #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION. 247 * A message of type #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION.
240 */ 248 */
@@ -268,7 +276,8 @@ struct AddressSuggestionMessage {
268/** 276/**
269 * 277 *
270 */ 278 */
271struct PeerInformationMessage { 279struct PeerInformationMessage
280{
272 /** 281 /**
273 * Type is #GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION 282 * Type is #GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION
274 */ 283 */
@@ -330,7 +339,8 @@ struct PeerInformationMessage {
330/** 339/**
331 * Client to service: please give us an overview of the addresses. 340 * Client to service: please give us an overview of the addresses.
332 */ 341 */
333struct AddressListRequestMessage { 342struct AddressListRequestMessage
343{
334 /** 344 /**
335 * Type is #GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_REQUEST 345 * Type is #GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_REQUEST
336 */ 346 */
@@ -357,7 +367,8 @@ struct AddressListRequestMessage {
357/** 367/**
358 * 368 *
359 */ 369 */
360struct ReservationRequestMessage { 370struct ReservationRequestMessage
371{
361 /** 372 /**
362 * Type is #GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST 373 * Type is #GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST
363 */ 374 */
@@ -378,7 +389,8 @@ struct ReservationRequestMessage {
378/** 389/**
379 * 390 *
380 */ 391 */
381struct ReservationResultMessage { 392struct ReservationResultMessage
393{
382 /** 394 /**
383 * Type is #GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT 395 * Type is #GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT
384 */ 396 */
@@ -405,7 +417,8 @@ struct ReservationResultMessage {
405 * Variable-size entry in a `struct ChangePreferenceMessage` or 417 * Variable-size entry in a `struct ChangePreferenceMessage` or
406 * `struct FeedbackPreferenceMessage`. 418 * `struct FeedbackPreferenceMessage`.
407 */ 419 */
408struct PreferenceInformation { 420struct PreferenceInformation
421{
409 /** 422 /**
410 * An `enum GNUNET_ATS_PreferenceKind` in NBO. 423 * An `enum GNUNET_ATS_PreferenceKind` in NBO.
411 */ 424 */
@@ -422,7 +435,8 @@ struct PreferenceInformation {
422/** 435/**
423 * Client to ATS: I have a performance preference for a peer. 436 * Client to ATS: I have a performance preference for a peer.
424 */ 437 */
425struct ChangePreferenceMessage { 438struct ChangePreferenceMessage
439{
426 /** 440 /**
427 * Type is #GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE. 441 * Type is #GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE.
428 */ 442 */
@@ -447,7 +461,8 @@ struct ChangePreferenceMessage {
447/** 461/**
448 * Message containing application feedback for a peer 462 * Message containing application feedback for a peer
449 */ 463 */
450struct FeedbackPreferenceMessage { 464struct FeedbackPreferenceMessage
465{
451 /** 466 /**
452 * Type is #GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_FEEDBACK. 467 * Type is #GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_FEEDBACK.
453 */ 468 */