/*
This file is part of GNUnet.
- (C) 2010,2011 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010-2015 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
* @file ats/ats.h
#define ATS_H
#include "gnunet_util_lib.h"
+#include "gnunet_ats_service.h"
+
/**
* Flag used to indicate which type of client is connecting
enum StartFlag
{
+ /**
+ * This is a scheduling client (aka transport service)
+ */
START_FLAG_SCHEDULING = 0,
+ /**
+ * Performance monitoring client that wants to learn about
+ * changes in performance characteristics.
+ */
START_FLAG_PERFORMANCE_WITH_PIC = 1,
- START_FLAG_PERFORMANCE_NO_PIC = 2
+ /**
+ * Performance monitoring client that does NOT want to learn
+ * about changes in performance characteristics.
+ */
+ START_FLAG_PERFORMANCE_NO_PIC = 2,
+
+ /**
+ * Connection suggestion handle.
+ */
+ START_FLAG_CONNECTION_SUGGESTION = 3
};
GNUNET_NETWORK_STRUCT_BEGIN
+/**
+ * First message any client sends to ATS, used to self-identify
+ * (what type of client this is).
+ */
struct ClientStartMessage
{
+ /**
+ * Type is #GNUNET_MESSAGE_TYPE_ATS_START.
+ */
struct GNUNET_MessageHeader header;
/**
};
+/**
+ * Connectivity client to ATS service: we would like to have
+ * address suggestions for this peer.
+ */
struct RequestAddressMessage
{
+ /**
+ * Type is #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS or
+ * #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL to stop
+ * suggestions.
+ */
struct GNUNET_MessageHeader header;
- uint32_t reserved GNUNET_PACKED;
-
- struct GNUNET_PeerIdentity peer;
-};
-
-struct ResetBackoffMessage
-{
- struct GNUNET_MessageHeader header;
-
- uint32_t reserved GNUNET_PACKED;
+ /**
+ * How "strong" is our need for an address for this peer?
+ */
+ uint32_t strength GNUNET_PACKED;
+ /**
+ * Peer to get address suggestions for.
+ */
struct GNUNET_PeerIdentity peer;
};
/**
- * ATS client to ATS service: here is another address you can use.
+ * Scheduling client to ATS service: here is another address you can use.
*/
struct AddressAddMessage
{
*/
struct GNUNET_MessageHeader header;
- /**
- * Size of the `struct GNUNET_ATS_Information` array that follows this struct.
- */
- uint32_t ats_count GNUNET_PACKED;
-
- /**
- * Identity of the peer that this address is for.
- */
- struct GNUNET_PeerIdentity peer;
-
/**
* Number of bytes in the address that follows this struct.
*/
*/
uint16_t plugin_name_length GNUNET_PACKED;
+ /**
+ * Identity of the peer that this address is for.
+ */
+ struct GNUNET_PeerIdentity peer;
+
/**
* Internal number this client will henceforth use to
* refer to this address.
*/
uint32_t address_local_info GNUNET_PACKED;
+ /**
+ * Performance properties of the address.
+ */
+ struct GNUNET_ATS_PropertiesNBO properties;
+
/* followed by:
- * - struct GNUNET_ATS_Information [ats_count];
* - char address[address_length]
* - char plugin_name[plugin_name_length] (including '\0'-termination).
*/
};
+/**
+ * Message used to notify ATS that the performance
+ * characteristics for an address have changed.
+ */
struct AddressUpdateMessage
{
+ /**
+ * Message of type #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE.
+ */
struct GNUNET_MessageHeader header;
- uint32_t ats_count GNUNET_PACKED;
-
- struct GNUNET_PeerIdentity peer;
-
-
- uint16_t address_length GNUNET_PACKED;
-
- uint16_t plugin_name_length GNUNET_PACKED;
-
+ /**
+ * Internal number this client uses to refer to this address.
+ */
uint32_t session_id GNUNET_PACKED;
- uint32_t address_local_info GNUNET_PACKED;
+ /**
+ * Which peer is this about? (Technically redundant, as the
+ * @e session_id should be sufficient, but enables ATS service
+ * to find the session faster).
+ */
+ struct GNUNET_PeerIdentity peer;
- /* followed by:
- * - struct GNUNET_ATS_Information [ats_count];
- * - char address[address_length]
- * - char plugin_name[plugin_name_length] (including '\0'-termination).
+ /**
+ * Performance properties of the address.
*/
+ struct GNUNET_ATS_PropertiesNBO properties;
};
-struct AddressUseMessage
+
+/**
+ * Message sent by ATS client to ATS service when an address
+ * was destroyed and must thus henceforth no longer be considered
+ * for scheduling.
+ */
+struct AddressDestroyedMessage
{
+ /**
+ * Type is #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED.
+ */
struct GNUNET_MessageHeader header;
- struct GNUNET_PeerIdentity peer;
-
- uint16_t in_use GNUNET_PACKED;
-
- uint16_t address_length GNUNET_PACKED;
-
- uint16_t plugin_name_length GNUNET_PACKED;
-
+ /**
+ * Internal number this client uses to refer to this address.
+ */
uint32_t session_id GNUNET_PACKED;
- uint32_t address_local_info GNUNET_PACKED;
-
- /* followed by:
- * - char address[address_length]
- * - char plugin_name[plugin_name_length] (including '\0'-termination).
+ /**
+ * Which peer is this about? (Technically redundant, as the
+ * @e session_id should be sufficient, but enables ATS service
+ * to find the session faster).
*/
+ struct GNUNET_PeerIdentity peer;
};
-struct AddressDestroyedMessage
+/**
+ * Message sent by ATS service to client to confirm that it is done
+ * using the given session ID.
+ */
+struct GNUNET_ATS_SessionReleaseMessage
{
+ /**
+ * Type is #GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE.
+ */
struct GNUNET_MessageHeader header;
- uint32_t reserved GNUNET_PACKED;
-
- struct GNUNET_PeerIdentity peer;
-
- uint16_t address_length GNUNET_PACKED;
-
- uint16_t plugin_name_length GNUNET_PACKED;
-
+ /**
+ * Number the client used to identify the session.
+ */
uint32_t session_id GNUNET_PACKED;
- uint32_t address_local_info GNUNET_PACKED;
-
- /* followed by:
- * - char address[address_length]
- * - char plugin_name[plugin_name_length] (including '\0'-termination).
+ /**
+ * Which peer is this about? (Technically redundant, as the
+ * @e session_id should be sufficient, but may enable client
+ * to find the session faster).
*/
-
+ struct GNUNET_PeerIdentity peer;
};
+
+/**
+ * ATS Service suggests to the transport service to use the address
+ * identified by the given @e session_id for the given @e peer with
+ * the given @e bandwidth_in and @e bandwidth_out limits from now on.
+ */
struct AddressSuggestionMessage
{
+ /**
+ * A message of type #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION.
+ */
struct GNUNET_MessageHeader header;
- uint32_t ats_count GNUNET_PACKED;
-
- struct GNUNET_PeerIdentity peer;
-
- uint16_t address_length GNUNET_PACKED;
-
- uint16_t plugin_name_length GNUNET_PACKED;
-
+ /**
+ * Internal number this client uses to refer to the address this
+ * suggestion is about.
+ */
uint32_t session_id GNUNET_PACKED;
- uint32_t address_local_info GNUNET_PACKED;
+ /**
+ * Which peer is this about? (Technically redundant, as the
+ * @e session_id should be sufficient, but may enable client
+ * to find the session faster and/or check consistency).
+ */
+ struct GNUNET_PeerIdentity peer;
+ /**
+ * How much bandwidth we are allowed for sending.
+ */
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
-
- /* followed by:
- * - struct GNUNET_ATS_Information [ats_count];
- * - char address[address_length]
- * - char plugin_name[plugin_name_length] (including '\0'-termination).
+ /**
+ * How much bandwidth we are allowed for receiving.
*/
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
};
+/**
+ *
+ */
struct PeerInformationMessage
{
+ /**
+ * Type is #GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION
+ */
struct GNUNET_MessageHeader header;
- uint32_t ats_count GNUNET_PACKED;
-
- uint32_t address_active GNUNET_PACKED;
+ /**
+ *
+ */
+ uint16_t address_length GNUNET_PACKED;
- uint32_t id GNUNET_PACKED;
+ /**
+ *
+ */
+ uint16_t plugin_name_length GNUNET_PACKED;
+ /**
+ *
+ */
struct GNUNET_PeerIdentity peer;
- uint16_t address_length GNUNET_PACKED;
+ /**
+ *
+ */
+ uint32_t address_active GNUNET_PACKED;
- uint16_t plugin_name_length GNUNET_PACKED;
+ /**
+ *
+ */
+ uint32_t id GNUNET_PACKED;
+ /**
+ *
+ */
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
+ /**
+ *
+ */
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
+ /**
+ * Performance properties of the address.
+ */
+ struct GNUNET_ATS_PropertiesNBO properties;
+
+ /**
+ * Local-only information of the address, see
+ * `enum GNUNET_HELLO_AddressInfo`.
+ */
+ uint32_t address_local_info GNUNET_PACKED;
+
/* followed by:
- * - struct GNUNET_ATS_Information [ats_count];
* - char address[address_length]
* - char plugin_name[plugin_name_length] (including '\0'-termination).
*/
};
+/**
+ *
+ */
struct ReservationRequestMessage
{
+ /**
+ * Type is #GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST
+ */
struct GNUNET_MessageHeader header;
+ /**
+ *
+ */
int32_t amount GNUNET_PACKED;
+ /**
+ *
+ */
struct GNUNET_PeerIdentity peer;
};
/**
- * Message sent by ATS service to client to confirm that it is done
- * using the given session ID.
+ *
*/
-struct SessionReleaseMessage
-{
- struct GNUNET_MessageHeader header;
-
- uint32_t session_id GNUNET_PACKED;
-
- struct GNUNET_PeerIdentity peer;
-};
-
-
struct ReservationResultMessage
{
+ /**
+ * Type is #GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT
+ */
struct GNUNET_MessageHeader header;
+ /**
+ *
+ */
int32_t amount GNUNET_PACKED;
+ /**
+ *
+ */
struct GNUNET_PeerIdentity peer;
+ /**
+ *
+ */
struct GNUNET_TIME_RelativeNBO res_delay;
};
+
+/**
+ * Variable-size entry in a `struct ChangePreferenceMessage` or
+ * `struct FeedbackPreferenceMessage`.
+ */
struct PreferenceInformation
{
+ /**
+ * An `enum GNUNET_ATS_PreferenceKind` in NBO.
+ */
uint32_t preference_kind GNUNET_PACKED;
+ /**
+ * Degree of preference (or appreciation) for this @e
+ * preference_kind being expressed.
+ */
float preference_value GNUNET_PACKED;
};
+/**
+ * Client to ATS: I have a performance preference for a peer.
+ */
struct ChangePreferenceMessage
{
+ /**
+ * Type is #GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE.
+ */
struct GNUNET_MessageHeader header;
+ /**
+ * How many `struct PreferenceInformation` entries follow
+ * this struct?
+ */
uint32_t num_preferences GNUNET_PACKED;
+ /**
+ * Which peer is the preference being expressed for?
+ */
struct GNUNET_PeerIdentity peer;
/* followed by 'num_preferences'
*/
struct FeedbackPreferenceMessage
{
+ /**
+ * Type is #GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_FEEDBACK.
+ */
struct GNUNET_MessageHeader header;
/**
projects / oweals / gnunet.git / blobdiff