networkpacket.h

Go to the documentation of this file.

/*
Minetest
Copyright (C) 2015 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
 
#pragma once
 
#include "util/pointer.h"
#include "networkprotocol.h"
#include <SColor.h>
 
class NetworkPacket
{
public:
    NetworkPacket(u16 command, u32 preallocate, session_t peer_id) :
        m_command(command), m_peer_id(peer_id)
    {
        m_data.reserve(preallocate);
    }
    NetworkPacket(u16 command, u32 preallocate) :
        m_command(command)
    {
        m_data.reserve(preallocate);
    }
    NetworkPacket() = default;
 
    ~NetworkPacket() = default;
 
    void putRawPacket(const u8 *data, u32 datasize, session_t peer_id);
    void clear();
 
    // Getters
    u32 getSize() const { return m_datasize; }
    session_t getPeerId() const { return m_peer_id; }
    u16 getCommand() const { return m_command; }
    u32 getRemainingBytes() const { return m_datasize - m_read_offset; }
    const char *getRemainingString() { return getString(m_read_offset); }
 
    // Returns a c-string without copying.
    // A better name for this would be getRawString()
    const char *getString(u32 from_offset) const;
    // major difference to putCString(): doesn't write len into the buffer
    void putRawString(const char *src, u32 len);
    void putRawString(std::string_view src)
    {
        putRawString(src.data(), src.size());
    }
 
    NetworkPacket &operator>>(std::string &dst);
    NetworkPacket &operator<<(std::string_view src);
 
    void putLongString(std::string_view src);
 
    NetworkPacket &operator>>(std::wstring &dst);
    NetworkPacket &operator<<(std::wstring_view src);
 
    std::string readLongString();
 
    NetworkPacket &operator>>(char &dst);
    NetworkPacket &operator<<(char src);
 
    NetworkPacket &operator>>(bool &dst);
    NetworkPacket &operator<<(bool src);
 
    u8 getU8(u32 offset);
 
    NetworkPacket &operator>>(u8 &dst);
    NetworkPacket &operator<<(u8 src);
 
    u8 *getU8Ptr(u32 offset);
 
    u16 getU16(u32 from_offset);
    NetworkPacket &operator>>(u16 &dst);
    NetworkPacket &operator<<(u16 src);
 
    NetworkPacket &operator>>(u32 &dst);
    NetworkPacket &operator<<(u32 src);
 
    NetworkPacket &operator>>(u64 &dst);
    NetworkPacket &operator<<(u64 src);
 
    NetworkPacket &operator>>(float &dst);
    NetworkPacket &operator<<(float src);
 
    NetworkPacket &operator>>(v2f &dst);
    NetworkPacket &operator<<(v2f src);
 
    NetworkPacket &operator>>(v3f &dst);
    NetworkPacket &operator<<(v3f src);
 
    NetworkPacket &operator>>(s16 &dst);
    NetworkPacket &operator<<(s16 src);
 
    NetworkPacket &operator>>(s32 &dst);
    NetworkPacket &operator<<(s32 src);
 
    NetworkPacket &operator>>(v2s32 &dst);
    NetworkPacket &operator<<(v2s32 src);
 
    NetworkPacket &operator>>(v3s16 &dst);
    NetworkPacket &operator<<(v3s16 src);
 
    NetworkPacket &operator>>(v3s32 &dst);
    NetworkPacket &operator<<(v3s32 src);
 
    NetworkPacket &operator>>(video::SColor &dst);
    NetworkPacket &operator<<(video::SColor src);
 
    // Temp, we remove SharedBuffer when migration finished
    // ^ this comment has been here for 7 years
    Buffer<u8> oldForgePacket();
 
private:
    void checkReadOffset(u32 from_offset, u32 field_size) const;
 
    inline void checkDataSize(u32 field_size)
    {
        if (m_read_offset + field_size > m_datasize) {
            m_datasize = m_read_offset + field_size;
            m_data.resize(m_datasize);
        }
    }
 
    std::vector<u8> m_data;
    u32 m_datasize = 0;
    u32 m_read_offset = 0;
    u16 m_command = 0;
    session_t m_peer_id = 0;
};