src/MultiPlayer/mpmessages.hxx

   1 // mpmessages.hxx -- Message definitions for multiplayer communications
   2 // within a multiplayer Flightgear
   3 //
   4 // Written by Duncan McCreanor, started February 2003.
   5 // duncan.mccreanor@airservicesaustralia.com
   6 //
   7 // Copyright (C) 2003  Airservices Australia
   8 //
   9 // This program is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU General Public License as
  11 // published by the Free Software Foundation; either version 2 of the
  12 // License, or (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful, but
  15 // WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 // General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22 //
  23
  24 #ifndef MPMESSAGES_H
  25 #define MPMESSAGES_H
  26
  27 #define MPMESSAGES_HID "$Id$"
  28
  29 /****************************************************************
  30 * @version $Id$
  31 *
  32 * Description: Each message used for multiplayer communications
  33 * consists of a header and optionally a block of data. The combined
  34 * header and data is sent as one IP packet.
  35 *
  36 ******************************************************************/
  37
  38 #include <vector>
  39
  40 #include <simgear/compiler.h>
  41 #include <simgear/props/props.hxx>
  42 #include <simgear/math/SGMath.hxx>
  43 #include "tiny_xdr.hxx"
  44
  45 // magic value for messages
  46 const uint32_t MSG_MAGIC = 0x46474653;  // "FGFS"
  47 // protocoll version
  48 const uint32_t PROTO_VER = 0x00010001;  // 1.1
  49
  50 // Message identifiers
  51 #define CHAT_MSG_ID             1
  52 #define UNUSABLE_POS_DATA_ID    2
  53 #define OLD_OLD_POS_DATA_ID     3
  54 #define OLD_POS_DATA_ID         4
  55 #define OLD_PROP_MSG_ID         5
  56 #define RESET_DATA_ID           6
  57 #define POS_DATA_ID             7
  58
  59 // XDR demands 4 byte alignment, but some compilers use8 byte alignment
  60 // so it's safe to let the overall size of a network message be a
  61 // multiple of 8!
  62 #define MAX_CALLSIGN_LEN        8
  63 #define MAX_CHAT_MSG_LEN        256
  64 #define MAX_MODEL_NAME_LEN      96
  65 #define MAX_PROPERTY_LEN        52
  66
  67 // Header for use with all messages sent
  68 struct T_MsgHdr {
  69     xdr_data_t  Magic;                  // Magic Value
  70     xdr_data_t  Version;                // Protocoll version
  71     xdr_data_t  MsgId;                  // Message identifier
  72     xdr_data_t  MsgLen;                 // absolute length of message
  73     xdr_data_t  ReplyAddress;           // (player's receiver address
  74     xdr_data_t  ReplyPort;              // player's receiver port
  75     char Callsign[MAX_CALLSIGN_LEN];    // Callsign used by the player
  76 };
  77
  78 // Chat message
  79 struct T_ChatMsg {
  80     char Text[MAX_CHAT_MSG_LEN];       // Text of chat message
  81 };
  82
  83 // Position message
  84 struct T_PositionMsg {
  85     char Model[MAX_MODEL_NAME_LEN];    // Name of the aircraft model
  86
  87     // Time when this packet was generated
  88     xdr_data2_t time;
  89     xdr_data2_t lag;
  90
  91     // position wrt the earth centered frame
  92     xdr_data2_t position[3];
  93     // orientation wrt the earth centered frame, stored in the angle axis
  94     // representation where the angle is coded into the axis length
  95     xdr_data_t orientation[3];
  96
  97     // linear velocity wrt the earth centered frame measured in
  98     // the earth centered frame
  99     xdr_data_t linearVel[3];
 100     // angular velocity wrt the earth centered frame measured in
 101     // the earth centered frame
 102     xdr_data_t angularVel[3];
 103
 104     // linear acceleration wrt the earth centered frame measured in
 105     // the earth centered frame
 106     xdr_data_t linearAccel[3];
 107     // angular acceleration wrt the earth centered frame measured in
 108     // the earth centered frame
 109     xdr_data_t angularAccel[3];
 110     // Padding. The alignment is 8 bytes on x86_64 because there are
 111     // 8-byte types in the message, so the size should be explicitly
 112     // rounded out to a multiple of 8. Of course, it's a bad idea to
 113     // put a C struct directly on the wire, but that's a fight for
 114     // another day...
 115     xdr_data_t pad;
 116 };
 117
 118 struct FGPropertyData {
 119   unsigned id;
 120
 121   // While the type isn't transmitted, it is needed for the destructor
 122   simgear::props::Type type;
 123   union {
 124     int int_value;
 125     float float_value;
 126     char* string_value;
 127   };
 128
 129   ~FGPropertyData() {
 130     if ((type == simgear::props::STRING) || (type == simgear::props::UNSPECIFIED))
 131     {
 132       delete [] string_value;
 133     }
 134   }
 135 };
 136
 137
 138
 139 // Position message
 140 struct FGExternalMotionData {
 141   // simulation time when this packet was generated
 142   double time;
 143   // the artificial lag the client should stay behind the average
 144   // simulation time to arrival time difference
 145   // FIXME: should be some 'per model' instead of 'per packet' property
 146   double lag;
 147
 148   // position wrt the earth centered frame
 149   SGVec3d position;
 150   // orientation wrt the earth centered frame
 151   SGQuatf orientation;
 152
 153   // linear velocity wrt the earth centered frame measured in
 154   // the earth centered frame
 155   SGVec3f linearVel;
 156   // angular velocity wrt the earth centered frame measured in
 157   // the earth centered frame
 158   SGVec3f angularVel;
 159
 160   // linear acceleration wrt the earth centered frame measured in
 161   // the earth centered frame
 162   SGVec3f linearAccel;
 163   // angular acceleration wrt the earth centered frame measured in
 164   // the earth centered frame
 165   SGVec3f angularAccel;
 166
 167   // The set of properties received for this timeslot
 168   std::vector<FGPropertyData*> properties;
 169
 170   ~FGExternalMotionData()
 171   {
 172       std::vector<FGPropertyData*>::const_iterator propIt;
 173       std::vector<FGPropertyData*>::const_iterator propItEnd;
 174       propIt = properties.begin();
 175       propItEnd = properties.end();
 176
 177       while (propIt != propItEnd)
 178       {
 179         delete *propIt;
 180         propIt++;
 181       }
 182   }
 183 };
 184
 185 #endif