From 64f914d56ad114eb4bd0d076ca9b28ce64c67839 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Thu, 13 Oct 2011 13:22:05 +0000 Subject: [PATCH] documenting --- src/include/gnunet_protocols.h | 44 +++++++++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 3 deletions(-) diff --git a/src/include/gnunet_protocols.h b/src/include/gnunet_protocols.h index 9f106c3a9..ce14a9f20 100644 --- a/src/include/gnunet_protocols.h +++ b/src/include/gnunet_protocols.h @@ -990,21 +990,59 @@ extern "C" * ATS message types ******************************************************************************/ +/** + * Type of the 'struct ClientStartMessage' sent by clients to ATS to + * identify the type of the client. + */ #define GNUNET_MESSAGE_TYPE_ATS_START 340 +/** + * Type of the 'struct RequestAddressMessage' sent by clients to ATS + * to request an address to help connect. + */ #define GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS 341 +/** + * Type of the 'struct AddressUpdateMessage' sent by clients to ATS + * to inform ATS about performance changes. + */ #define GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE 342 +/** + * Type of the 'struct AddressDestroyedMessage' sent by clients to ATS + * to inform ATS about an address being unavailable. + */ #define GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED 343 +/** + * Type of the 'struct AddressSuggestionMessage' sent by ATS to clients + * to suggest switching to a different address. + */ #define GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION 344 -#define GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST 345 +/** + * Type of the 'struct PeerInformationMessage' sent by ATS to clients + * to inform about QoS for a particular connection. + */ +#define GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION 345 -#define GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT 346 +/** + * Type of the 'struct ReservationRequestMessage' sent by clients to ATS + * to ask for inbound bandwidth reservations. + */ +#define GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST 346 -#define GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE 347 +/** + * Type of the 'struct ReservationResultMessage' sent by ATS to clients + * in response to a reservation request. + */ +#define GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT 347 + +/** + * Type of the 'struct ChangePreferenceMessage' sent by clients to ATS + * to ask for allocation preference changes. + */ +#define GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE 348 /******************************************************************************* -- 2.25.1