Leviathan::NetworkRequest Class Reference

#include <NetworkRequest.h>

Inheritance diagram for Leviathan::NetworkRequest:

Public Member Functions
	NetworkRequest (NETWORK_REQUEST_TYPE type, uint32_t idforresponse=0)
virtual	~NetworkRequest ()
void	AddDataToPacket (sf::Packet &packet) const
NETWORK_REQUEST_TYPE	GetType () const
uint32_t	GetIDForResponse () const

Static Public Member Functions
static DLLEXPORT std::shared_ptr< NetworkRequest >	LoadFromPacket (sf::Packet &packet, uint32_t messagenumber)

Protected Member Functions
virtual DLLEXPORT void	_SerializeCustom (sf::Packet &packet) const =0
	Base classes serialize their data. More...

Protected Attributes
const NETWORK_REQUEST_TYPE	Type
const uint32_t	IDForResponse = 0

Detailed Description

Base class for all request objects

Note

Even though it cannot be required by the base class, sub classes should implement a constructor taking in an sf::Packet object

Definition at line 78 of file NetworkRequest.h.

Constructor & Destructor Documentation

NetworkRequest()

Leviathan::NetworkRequest::NetworkRequest ( NETWORK_REQUEST_TYPE  type, uint32_t  idforresponse = 0  )

inline

Definition at line 81 of file NetworkRequest.h.

                                                                          :
        Type(type), IDForResponse(idforresponse)
    {
        
    }

~NetworkRequest()

virtual Leviathan::NetworkRequest::~NetworkRequest ( )

inlinevirtual

Definition at line 87 of file NetworkRequest.h.

{};

Member Function Documentation

_SerializeCustom()

virtual DLLEXPORT void Leviathan::NetworkRequest::_SerializeCustom ( sf::Packet &  packet ) const

protectedpure virtual

Base classes serialize their data.

Implemented in Leviathan::RequestNone, and Leviathan::RequestCustom.

AddDataToPacket()

void Leviathan::NetworkRequest::AddDataToPacket ( sf::Packet &  packet ) const

inline

Definition at line 89 of file NetworkRequest.h.

                                                       {

        packet << static_cast<uint16_t>(Type);

        _SerializeCustom(packet);
    }

GetIDForResponse()

uint32_t Leviathan::NetworkRequest::GetIDForResponse ( ) const

inline

Definition at line 100 of file NetworkRequest.h.

                                             {
        return IDForResponse;
    }

GetType()

NETWORK_REQUEST_TYPE Leviathan::NetworkRequest::GetType ( ) const

inline

Definition at line 96 of file NetworkRequest.h.

                                               {
        return Type;
    }

LoadFromPacket()

DLLEXPORT std::shared_ptr< NetworkRequest > NetworkRequest::LoadFromPacket ( sf::Packet &  packet, uint32_t  messagenumber  )

static

Definition at line 12 of file NetworkRequest.cpp.

{
    // Get the heading data //
    uint16_t tmpval;
    packet >> tmpval;

    if(!packet)
        throw InvalidArgument("packet has invalid format");

    const NETWORK_REQUEST_TYPE requesttype = static_cast<NETWORK_REQUEST_TYPE>(tmpval);

    // Try to create the additional data if required for this type //
    switch(requesttype){
    case NETWORK_REQUEST_TYPE::Echo:
        return std::make_shared<RequestNone>(requesttype, messagenumber, packet);
    case NETWORK_REQUEST_TYPE::Connect:
        return std::make_shared<RequestConnect>(messagenumber, packet);
    case NETWORK_REQUEST_TYPE::Security:
        return std::make_shared<RequestSecurity>(messagenumber, packet);
    case NETWORK_REQUEST_TYPE::Authenticate:
        return std::make_shared<RequestAuthenticate>(messagenumber, packet);
    case NETWORK_REQUEST_TYPE::JoinServer:
        return std::make_shared<RequestJoinServer>(messagenumber, packet);
    default:
        {
            Logger::Get()->Warning("NetworkRequest: unused type: "+
                Convert::ToString(static_cast<int>(requesttype)));
            throw InvalidArgument("packet has request type that is missing from "
                "switch(requesttype)");
        }
        break;
    }
}

Member Data Documentation

IDForResponse

const uint32_t Leviathan::NetworkRequest::IDForResponse = 0

protected

Definition at line 114 of file NetworkRequest.h.

Type

const NETWORK_REQUEST_TYPE Leviathan::NetworkRequest::Type

protected

Definition at line 112 of file NetworkRequest.h.

---

The documentation for this class was generated from the following files:

• NetworkRequest.h
• NetworkRequest.cpp