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
  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;
  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
  88 struct AddressDestroyedMessage
  89 {
  90   struct GNUNET_MessageHeader header;
  91
  92   uint32_t reserved GNUNET_PACKED;
  93
  94   struct GNUNET_PeerIdentity peer;
  95
  96   uint16_t address_length GNUNET_PACKED;
  97
  98   uint16_t plugin_name_length GNUNET_PACKED;
  99
 100   uint32_t session_id GNUNET_PACKED;
 101
 102   /* followed by:
 103      - char address[address_length]
 104      - char plugin_name[plugin_name_length] (including '\0'-termination).
 105   */
 106
 107 };
 108
 109
 110 struct AddressSuggestionMessage
 111 {
 112   struct GNUNET_MessageHeader header;
 113
 114   uint32_t ats_count GNUNET_PACKED;
 115
 116   struct GNUNET_PeerIdentity peer;
 117
 118   uint16_t address_length GNUNET_PACKED;
 119
 120   uint16_t plugin_name_length GNUNET_PACKED;
 121
 122   uint32_t session_id GNUNET_PACKED;
 123
 124   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
 125
 126   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
 127
 128   /* followed by:
 129      - struct GNUNET_ATS_Information [ats_count];
 130      - char address[address_length]
 131      - char plugin_name[plugin_name_length] (including '\0'-termination).
 132   */
 133
 134 };
 135
 136
 137 struct PeerInformationMessage
 138 {
 139   struct GNUNET_MessageHeader header;
 140
 141   uint32_t ats_count GNUNET_PACKED;
 142
 143   struct GNUNET_PeerIdentity peer;
 144
 145   uint16_t address_length GNUNET_PACKED;
 146
 147   uint16_t plugin_name_length GNUNET_PACKED;
 148
 149   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
 150
 151   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
 152
 153   /* followed by:
 154      - struct GNUNET_ATS_Information [ats_count];
 155      - char address[address_length]
 156      - char plugin_name[plugin_name_length] (including '\0'-termination).
 157   */
 158
 159 };
 160
 161
 162 struct ReservationRequestMessage
 163 {
 164   struct GNUNET_MessageHeader header;
 165
 166   int32_t amount GNUNET_PACKED;
 167
 168   struct GNUNET_PeerIdentity peer;
 169 };
 170
 171
 172 /**
 173  * Message sent by ATS service to client to confirm that it is done
 174  * using the given session ID.
 175  */
 176 struct SessionReleaseMessage
 177 {
 178   struct GNUNET_MessageHeader header;
 179
 180   uint32_t session_id GNUNET_PACKED;
 181
 182   struct GNUNET_PeerIdentity peer;
 183 };
 184
 185
 186 struct ReservationResultMessage
 187 {
 188   struct GNUNET_MessageHeader header;
 189
 190   int32_t amount GNUNET_PACKED;
 191
 192   struct GNUNET_PeerIdentity peer;
 193
 194   struct GNUNET_TIME_RelativeNBO res_delay;
 195 };
 196
 197
 198 struct PreferenceInformation
 199 {
 200
 201   uint32_t preference_kind GNUNET_PACKED;
 202
 203   float preference_value GNUNET_PACKED;
 204
 205 };
 206
 207
 208 struct ChangePreferenceMessage
 209 {
 210   struct GNUNET_MessageHeader header;
 211
 212   uint32_t num_preferences GNUNET_PACKED;
 213
 214   struct GNUNET_PeerIdentity peer;
 215
 216   /* followed by 'num_preferences'
 217      struct PreferenceInformation values */
 218 };
 219
 220
 221
 222 #endif