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 #pragma once
  21
  22 #include "util/pointer.h"
  23 #include "util/numeric.h"
  24 #include "networkprotocol.h"
  25 #include <SColor.h>
  26
  27 class NetworkPacket
  28 {
  29
  30 public:
  31         NetworkPacket(u16 command, u32 datasize, session_t peer_id);
  32         NetworkPacket(u16 command, u32 datasize);
  33         NetworkPacket() = default;
  34
  35         ~NetworkPacket();
  36
  37         void putRawPacket(const u8 *data, u32 datasize, session_t peer_id);
  38         void clear();
  39
  40         // Getters
  41         u32 getSize() const { return m_datasize; }
  42         session_t getPeerId() const { return m_peer_id; }
  43         u16 getCommand() { return m_command; }
  44         u32 getRemainingBytes() const { return m_datasize - m_read_offset; }
  45         const char *getRemainingString() { return getString(m_read_offset); }
  46
  47         // Returns a c-string without copying.
  48         // A better name for this would be getRawString()
  49         const char *getString(u32 from_offset);
  50         // major difference to putCString(): doesn't write len into the buffer
  51         void putRawString(const char *src, u32 len);
  52         void putRawString(const std::string &src)
  53         {
  54                 putRawString(src.c_str(), src.size());
  55         }
  56
  57         NetworkPacket &operator>>(std::string &dst);
  58         NetworkPacket &operator<<(const std::string &src);
  59
  60         void putLongString(const std::string &src);
  61
  62         NetworkPacket &operator>>(std::wstring &dst);
  63         NetworkPacket &operator<<(const std::wstring &src);
  64
  65         std::string readLongString();
  66
  67         NetworkPacket &operator>>(char &dst);
  68         NetworkPacket &operator<<(char src);
  69
  70         NetworkPacket &operator>>(bool &dst);
  71         NetworkPacket &operator<<(bool src);
  72
  73         u8 getU8(u32 offset);
  74
  75         NetworkPacket &operator>>(u8 &dst);
  76         NetworkPacket &operator<<(u8 src);
  77
  78         u8 *getU8Ptr(u32 offset);
  79
  80         u16 getU16(u32 from_offset);
  81         NetworkPacket &operator>>(u16 &dst);
  82         NetworkPacket &operator<<(u16 src);
  83
  84         NetworkPacket &operator>>(u32 &dst);
  85         NetworkPacket &operator<<(u32 src);
  86
  87         NetworkPacket &operator>>(u64 &dst);
  88         NetworkPacket &operator<<(u64 src);
  89
  90         NetworkPacket &operator>>(float &dst);
  91         NetworkPacket &operator<<(float src);
  92
  93         NetworkPacket &operator>>(v2f &dst);
  94         NetworkPacket &operator<<(v2f src);
  95
  96         NetworkPacket &operator>>(v3f &dst);
  97         NetworkPacket &operator<<(v3f src);
  98
  99         NetworkPacket &operator>>(s16 &dst);
 100         NetworkPacket &operator<<(s16 src);
 101
 102         NetworkPacket &operator>>(s32 &dst);
 103         NetworkPacket &operator<<(s32 src);
 104
 105         NetworkPacket &operator>>(v2s32 &dst);
 106         NetworkPacket &operator<<(v2s32 src);
 107
 108         NetworkPacket &operator>>(v3s16 &dst);
 109         NetworkPacket &operator<<(v3s16 src);
 110
 111         NetworkPacket &operator>>(v3s32 &dst);
 112         NetworkPacket &operator<<(v3s32 src);
 113
 114         NetworkPacket &operator>>(video::SColor &dst);
 115         NetworkPacket &operator<<(video::SColor src);
 116
 117         // Temp, we remove SharedBuffer when migration finished
 118         // ^ this comment has been here for 4 years
 119         Buffer<u8> oldForgePacket();
 120
 121 private:
 122         void checkReadOffset(u32 from_offset, u32 field_size);
 123
 124         inline void checkDataSize(u32 field_size)
 125         {
 126                 if (m_read_offset + field_size > m_datasize) {
 127                         m_datasize = m_read_offset + field_size;
 128                         m_data.resize(m_datasize);
 129                 }
 130         }
 131
 132         std::vector<u8> m_data;
 133         u32 m_datasize = 0;
 134         u32 m_read_offset = 0;
 135         u16 m_command = 0;
 136         session_t m_peer_id = 0;
 137 };