documentation/3.0.1/Packet_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2025 Laurent Gomila (laurent@sfml-dev.org)

//

// This software is provided 'as-is', without any express or implied warranty.

// In no event will the authors be held liable for any damages arising from the use of this software.

//

// Permission is granted to anyone to use this software for any purpose,

// including commercial applications, and to alter it and redistribute it freely,

// subject to the following restrictions:

//

// 1. The origin of this software must not be misrepresented;

//    you must not claim that you wrote the original software.

//    If you use this software in a product, an acknowledgment

//    in the product documentation would be appreciated but is not required.

//

// 2. Altered source versions must be plainly marked as such,

//    and must not be misrepresented as being the original software.

//

// 3. This notice may not be removed or altered from any source distribution.

//


#pragma once


// Headers

#include <SFML/Network/Export.hpp>


#include <string>

#include <vector>


#include <cstddef>

#include <cstdint>


namespace sf

{

class String;


class SFML_NETWORK_API Packet

{

public:

    Packet() = default;


    virtual ~Packet() = default;


    Packet(const Packet&) = default;


    Packet& operator=(const Packet&) = default;


    Packet(Packet&&) noexcept = default;


    Packet& operator=(Packet&&) noexcept = default;


    void append(const void* data, std::size_t sizeInBytes);


    [[nodiscard]] std::size_t getReadPosition() const;


    void clear();


    [[nodiscard]] const void* getData() const;


    [[nodiscard]] std::size_t getDataSize() const;


    [[nodiscard]] bool endOfPacket() const;


    explicit operator bool() const;


    Packet& operator>>(bool& data);


    Packet& operator>>(std::int8_t& data);


    Packet& operator>>(std::uint8_t& data);


    Packet& operator>>(std::int16_t& data);


    Packet& operator>>(std::uint16_t& data);


    Packet& operator>>(std::int32_t& data);


    Packet& operator>>(std::uint32_t& data);


    Packet& operator>>(std::int64_t& data);


    Packet& operator>>(std::uint64_t& data);


    Packet& operator>>(float& data);


    Packet& operator>>(double& data);


    Packet& operator>>(char* data);


    Packet& operator>>(std::string& data);


    Packet& operator>>(wchar_t* data);


    Packet& operator>>(std::wstring& data);


    Packet& operator>>(String& data);


    Packet& operator<<(bool data);


    Packet& operator<<(std::int8_t data);


    Packet& operator<<(std::uint8_t data);


    Packet& operator<<(std::int16_t data);


    Packet& operator<<(std::uint16_t data);


    Packet& operator<<(std::int32_t data);


    Packet& operator<<(std::uint32_t data);


    Packet& operator<<(std::int64_t data);


    Packet& operator<<(std::uint64_t data);


    Packet& operator<<(float data);


    Packet& operator<<(double data);


    Packet& operator<<(const char* data);


    Packet& operator<<(const std::string& data);


    Packet& operator<<(const wchar_t* data);


    Packet& operator<<(const std::wstring& data);


    Packet& operator<<(const String& data);


protected:

    friend class TcpSocket;

    friend class UdpSocket;


    virtual const void* onSend(std::size_t& size);


    virtual void onReceive(const void* data, std::size_t size);


private:

    bool checkSize(std::size_t size);


    // Member data

    std::vector<std::byte> m_data;

    std::size_t            m_readPos{};

    std::size_t            m_sendPos{};

    bool                   m_isValid{true};

};


} // namespace sf


Export.hpp

SFML_NETWORK_API
#define SFML_NETWORK_API
Definition Network/Export.hpp:42

sf::Packet::operator=
Packet & operator=(const Packet &)=default
Copy assignment.

sf::Packet::getDataSize
std::size_t getDataSize() const
Get the size of the data contained in the packet.

sf::Packet::clear
void clear()
Clear the packet.

sf::Packet::Packet
Packet(Packet &&) noexcept=default
Move constructor.

sf::Packet::getReadPosition
std::size_t getReadPosition() const
Get the current reading position in the packet.

sf::Packet::endOfPacket
bool endOfPacket() const
Tell if the reading position has reached the end of the packet.

sf::Packet::Packet
Packet()=default
Default constructor.

sf::Packet::append
void append(const void *data, std::size_t sizeInBytes)
Append data to the end of the packet.

sf::Packet::getData
const void * getData() const
Get a pointer to the data contained in the packet.

sf::Packet::TcpSocket
friend class TcpSocket
Definition Packet.hpp:368

sf::Packet::~Packet
virtual ~Packet()=default
Virtual destructor.

sf::Packet::onReceive
virtual void onReceive(const void *data, std::size_t size)
Called after the packet is received over the network.

sf::Packet::Packet
Packet(const Packet &)=default
Copy constructor.

sf::Packet::UdpSocket
friend class UdpSocket
Definition Packet.hpp:369

sf::Packet::onSend
virtual const void * onSend(std::size_t &size)
Called before the packet is sent over the network.

sf::String
Utility string class that automatically handles conversions between types and encodings.
Definition String.hpp:89

sf
Definition AudioResource.hpp:36