Packet.hpp

Warning

This page refers to an old version of SFML. Click here to switch to the latest version.

• Main Page
• Namespaces
• Classes
• Files

• File List
• File Members

• SFML
• include
• SFML
• Network

Packet.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// 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.
//
 
#ifndef SFML_PACKET_HPP
#define SFML_PACKET_HPP

// Headers
#include <SFML/Config.hpp>
#include <string>
#include <vector>
 
 
namespace sf
{
class SFML_API Packet
{
public :

    Packet();

    virtual ~Packet();

    void Append(const void* Data, std::size_t SizeInBytes);

    void Clear();

    const char* GetData() const;

    std::size_t GetDataSize() const;

    bool EndOfPacket() const;

    operator bool() const;

    Packet& operator >>(bool&         Data);
    Packet& operator >>(Int8&         Data);
    Packet& operator >>(Uint8&        Data);
    Packet& operator >>(Int16&        Data);
    Packet& operator >>(Uint16&       Data);
    Packet& operator >>(Int32&        Data);
    Packet& operator >>(Uint32&       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 <<(bool                Data);
    Packet& operator <<(Int8                Data);
    Packet& operator <<(Uint8               Data);
    Packet& operator <<(Int16               Data);
    Packet& operator <<(Uint16              Data);
    Packet& operator <<(Int32               Data);
    Packet& operator <<(Uint32              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);
 
private :
 
    friend class SocketTCP;
    friend class SocketUDP;

    bool CheckSize(std::size_t Size);

    virtual const char* OnSend(std::size_t& DataSize);

    virtual void OnReceive(const char* Data, std::size_t DataSize);

    // Member data
    std::vector<char> myData;    
    std::size_t       myReadPos; 
    bool              myIsValid; 
};
 
} // namespace sf
 
 
#endif // SFML_PACKET_HPP