src/ats/ats.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010,2011 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20 /**
  21  * @file ats/ats.h
  22  * @brief automatic transport selection messages
  23  * @author Christian Grothoff
  24  * @author Matthias Wachs
  25  */
  26 #ifndef ATS_H
  27 #define ATS_H
  28
  29 #include "gnunet_util_lib.h"
  30
  31
  32 enum StartFlag
  33 {
  34
  35   START_FLAG_SCHEDULING = 0,
  36
  37   START_FLAG_PERFORMANCE_WITH_PIC = 1,
  38
  39   START_FLAG_PERFORMANCE_NO_PIC = 2
  40 };
  41
  42 GNUNET_NETWORK_STRUCT_BEGIN
  43
  44 struct ClientStartMessage
  45 {
  46   struct GNUNET_MessageHeader header;
  47
  48   /**
  49    * NBO value of an 'enum StartFlag'.
  50    */
  51   uint32_t start_flag GNUNET_PACKED;
  52 };
  53
  54
  55 struct RequestAddressMessage
  56 {
  57   struct GNUNET_MessageHeader header;
  58
  59   uint32_t reserved GNUNET_PACKED;
  60
  61   struct GNUNET_PeerIdentity peer;
  62 };
  63
  64
  65 struct AddressUpdateMessage
  66 {
  67   struct GNUNET_MessageHeader header;
  68
  69   uint32_t ats_count GNUNET_PACKED;
  70
  71   struct GNUNET_PeerIdentity peer;
  72
  73   uint16_t address_length GNUNET_PACKED;
  74
  75   uint16_t plugin_name_length GNUNET_PACKED;
  76
  77   uint32_t session_id GNUNET_PACKED;
  78
  79   /* followed by:
  80    * - struct GNUNET_ATS_Information [ats_count];
  81    * - char address[address_length]
  82    * - char plugin_name[plugin_name_length] (including '\0'-termination).
  83    */
  84
  85 };
  86
  87 struct AddressUseMessage
  88 {
  89   struct GNUNET_MessageHeader header;
  90
  91   struct GNUNET_PeerIdentity peer;
  92
  93   uint16_t in_use GNUNET_PACKED;
  94
  95   uint16_t address_length GNUNET_PACKED;
  96
  97   uint16_t plugin_name_length GNUNET_PACKED;
  98
  99   uint32_t session_id GNUNET_PACKED;
 100
 101   /* followed by:
 102    * - char address[address_length]
 103    * - char plugin_name[plugin_name_length] (including '\0'-termination).
 104    */
 105
 106 };
 107
 108
 109 struct AddressDestroyedMessage
 110 {
 111   struct GNUNET_MessageHeader header;
 112
 113   uint32_t reserved GNUNET_PACKED;
 114
 115   struct GNUNET_PeerIdentity peer;
 116
 117   uint16_t address_length GNUNET_PACKED;
 118
 119   uint16_t plugin_name_length GNUNET_PACKED;
 120
 121   uint32_t session_id GNUNET_PACKED;
 122
 123   /* followed by:
 124    * - char address[address_length]
 125    * - char plugin_name[plugin_name_length] (including '\0'-termination).
 126    */
 127
 128 };
 129
 130
 131 struct AddressSuggestionMessage
 132 {
 133   struct GNUNET_MessageHeader header;
 134
 135   uint32_t ats_count GNUNET_PACKED;
 136
 137   struct GNUNET_PeerIdentity peer;
 138
 139   uint16_t address_length GNUNET_PACKED;
 140
 141   uint16_t plugin_name_length GNUNET_PACKED;
 142
 143   uint32_t session_id GNUNET_PACKED;
 144
 145   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
 146
 147   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
 148
 149   /* followed by:
 150    * - struct GNUNET_ATS_Information [ats_count];
 151    * - char address[address_length]
 152    * - char plugin_name[plugin_name_length] (including '\0'-termination).
 153    */
 154
 155 };
 156
 157
 158 struct PeerInformationMessage
 159 {
 160   struct GNUNET_MessageHeader header;
 161
 162   uint32_t ats_count GNUNET_PACKED;
 163
 164   struct GNUNET_PeerIdentity peer;
 165
 166   uint16_t address_length GNUNET_PACKED;
 167
 168   uint16_t plugin_name_length GNUNET_PACKED;
 169
 170   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
 171
 172   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
 173
 174   /* followed by:
 175    * - struct GNUNET_ATS_Information [ats_count];
 176    * - char address[address_length]
 177    * - char plugin_name[plugin_name_length] (including '\0'-termination).
 178    */
 179
 180 };
 181
 182
 183 struct ReservationRequestMessage
 184 {
 185   struct GNUNET_MessageHeader header;
 186
 187   int32_t amount GNUNET_PACKED;
 188
 189   struct GNUNET_PeerIdentity peer;
 190 };
 191
 192
 193 /**
 194  * Message sent by ATS service to client to confirm that it is done
 195  * using the given session ID.
 196  */
 197 struct SessionReleaseMessage
 198 {
 199   struct GNUNET_MessageHeader header;
 200
 201   uint32_t session_id GNUNET_PACKED;
 202
 203   struct GNUNET_PeerIdentity peer;
 204 };
 205
 206
 207 struct ReservationResultMessage
 208 {
 209   struct GNUNET_MessageHeader header;
 210
 211   int32_t amount GNUNET_PACKED;
 212
 213   struct GNUNET_PeerIdentity peer;
 214
 215   struct GNUNET_TIME_RelativeNBO res_delay;
 216 };
 217
 218 struct PreferenceInformation
 219 {
 220
 221   uint32_t preference_kind GNUNET_PACKED;
 222
 223   float preference_value GNUNET_PACKED;
 224
 225 };
 226
 227
 228 struct ChangePreferenceMessage
 229 {
 230   struct GNUNET_MessageHeader header;
 231
 232   uint32_t num_preferences GNUNET_PACKED;
 233
 234   struct GNUNET_PeerIdentity peer;
 235
 236   /* followed by 'num_preferences'
 237    * struct PreferenceInformation values */
 238 };
 239 GNUNET_NETWORK_STRUCT_END
 240
 241
 242
 243 #endif