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
  45 struct ClientStartMessage
  46 {
  47   struct GNUNET_MessageHeader header;
  48
  49   /**
  50    * NBO value of an 'enum StartFlag'.
  51    */
  52   uint32_t start_flag;
  53 };
  54
  55
  56
  57 struct RequestAddressMessage
  58 {
  59   struct GNUNET_MessageHeader header;
  60
  61   uint32_t reserved GNUNET_PACKED;
  62
  63   struct GNUNET_PeerIdentity peer;
  64 };
  65
  66 struct AddressUpdateMessage
  67 {
  68   struct GNUNET_MessageHeader header;
  69
  70   uint32_t ats_count GNUNET_PACKED;
  71
  72   struct GNUNET_PeerIdentity peer;
  73
  74   uint16_t address_length GNUNET_PACKED;
  75
  76   uint16_t plugin_name_length GNUNET_PACKED;
  77
  78   uint32_t session_id GNUNET_PACKED;
  79
  80   /* followed by:
  81      - struct GNUNET_TRANSPORT_ATS_Information [ats_count];
  82      - char address[address_length]
  83      - char plugin_name[plugin_name_length] (including '\0'-termination).
  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_TRANSPORT_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
 138 struct PeerInformationMessage
 139 {
 140   struct GNUNET_MessageHeader header;
 141
 142   uint32_t ats_count GNUNET_PACKED;
 143
 144   struct GNUNET_PeerIdentity peer;
 145
 146   uint16_t address_length GNUNET_PACKED;
 147
 148   uint16_t plugin_name_length GNUNET_PACKED;
 149
 150   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
 151
 152   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
 153
 154   /* followed by:
 155      - struct GNUNET_TRANSPORT_ATS_Information [ats_count];
 156      - char address[address_length]
 157      - char plugin_name[plugin_name_length] (including '\0'-termination).
 158   */
 159
 160 };
 161
 162
 163
 164
 165 struct ReservationRequestMessage
 166 {
 167   struct GNUNET_MessageHeader header;
 168
 169   int32_t amount GNUNET_PACKED;
 170
 171   struct GNUNET_PeerIdentity peer;
 172 };
 173
 174
 175 struct ReservationResultMessage
 176 {
 177   struct GNUNET_MessageHeader header;
 178
 179   int32_t amount GNUNET_PACKED;
 180
 181   struct GNUNET_PeerIdentity peer;
 182
 183   struct GNUNET_TIME_RelativeNBO res_delay;
 184 };
 185
 186
 187 struct PreferenceInformation
 188 {
 189
 190   uint32_t preference_kind GNUNET_PACKED;
 191
 192   float preference_value GNUNET_PACKED;
 193
 194 };
 195
 196
 197 struct ChangePreferenceMessage
 198 {
 199   struct GNUNET_MessageHeader header;
 200
 201   uint32_t num_preferences GNUNET_PACKED;
 202
 203   struct GNUNET_PeerIdentity peer;
 204
 205   /* followed by 'num_preferences'
 206      struct PreferenceInformation values */
 207 };
 208
 209
 210
 211 #endif