src/network/networkpacket.h

   1 /*
   2 Minetest
   3 Copyright (C) 2015 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef NETWORKPACKET_HEADER
  21 #define NETWORKPACKET_HEADER
  22
  23 #include "util/pointer.h"
  24 #include "util/numeric.h"
  25 #include "networkprotocol.h"
  26
  27 class NetworkPacket
  28 {
  29
  30 public:
  31                 NetworkPacket(u16 command, u32 datasize, u16 peer_id);
  32                 NetworkPacket(u16 command, u32 datasize);
  33                 NetworkPacket() {}
  34                 ~NetworkPacket();
  35
  36                 void putRawPacket(u8 *data, u32 datasize, u16 peer_id);
  37
  38                 // Getters
  39                 u32 getSize() { return m_datasize; }
  40                 u16 getPeerId() { return m_peer_id; }
  41                 u16 getCommand() { return m_command; }
  42                 const u32 getRemainingBytes() const { return m_datasize - m_read_offset; }
  43                 const char* getRemainingString() { return getString(m_read_offset); }
  44
  45                 // Returns a c-string without copying.
  46                 // A better name for this would be getRawString()
  47                 const char* getString(u32 from_offset);
  48                 // major difference to putCString(): doesn't write len into the buffer
  49                 void putRawString(const char* src, u32 len);
  50                 void putRawString(const std::string &src)
  51                         { putRawString(src.c_str(), src.size()); }
  52
  53                 NetworkPacket& operator>>(std::string& dst);
  54                 NetworkPacket& operator<<(const std::string &src);
  55
  56                 void putLongString(const std::string &src);
  57
  58                 NetworkPacket& operator>>(std::wstring& dst);
  59                 NetworkPacket& operator<<(const std::wstring &src);
  60
  61                 std::string readLongString();
  62
  63                 char getChar(u32 offset);
  64                 NetworkPacket& operator>>(char& dst);
  65                 NetworkPacket& operator<<(char src);
  66
  67                 NetworkPacket& operator>>(bool& dst);
  68                 NetworkPacket& operator<<(bool src);
  69
  70                 u8 getU8(u32 offset);
  71
  72                 NetworkPacket& operator>>(u8& dst);
  73                 NetworkPacket& operator<<(u8 src);
  74
  75                 u8* getU8Ptr(u32 offset);
  76
  77                 u16 getU16(u32 from_offset);
  78                 NetworkPacket& operator>>(u16& dst);
  79                 NetworkPacket& operator<<(u16 src);
  80
  81                 NetworkPacket& operator>>(u32& dst);
  82                 NetworkPacket& operator<<(u32 src);
  83
  84                 NetworkPacket& operator>>(u64& dst);
  85                 NetworkPacket& operator<<(u64 src);
  86
  87                 NetworkPacket& operator>>(float& dst);
  88                 NetworkPacket& operator<<(float src);
  89
  90                 NetworkPacket& operator>>(v2f& dst);
  91                 NetworkPacket& operator<<(v2f src);
  92
  93                 NetworkPacket& operator>>(v3f& dst);
  94                 NetworkPacket& operator<<(v3f src);
  95
  96                 NetworkPacket& operator>>(s16& dst);
  97                 NetworkPacket& operator<<(s16 src);
  98
  99                 NetworkPacket& operator>>(s32& dst);
 100                 NetworkPacket& operator<<(s32 src);
 101
 102                 NetworkPacket& operator>>(v2s32& dst);
 103                 NetworkPacket& operator<<(v2s32 src);
 104
 105                 NetworkPacket& operator>>(v3s16& dst);
 106                 NetworkPacket& operator<<(v3s16 src);
 107
 108                 NetworkPacket& operator>>(v3s32& dst);
 109                 NetworkPacket& operator<<(v3s32 src);
 110
 111                 NetworkPacket& operator>>(video::SColor& dst);
 112                 NetworkPacket& operator<<(video::SColor src);
 113
 114                 // Temp, we remove SharedBuffer when migration finished
 115                 Buffer<u8> oldForgePacket();
 116 private:
 117                 void checkReadOffset(u32 from_offset, u32 field_size);
 118
 119                 inline void checkDataSize(u32 field_size)
 120                 {
 121                         if (m_read_offset + field_size > m_datasize) {
 122                                 m_datasize = m_read_offset + field_size;
 123                                 m_data.resize(m_datasize);
 124                         }
 125                 }
 126
 127                 std::vector<u8> m_data;
 128                 u32 m_datasize = 0;
 129                 u32 m_read_offset = 0;
 130                 u16 m_command = 0;
 131                 u16 m_peer_id = 0;
 132 };
 133
 134 #endif