pge_network::PgeNetworkStub Class Reference

The primary interface to stubbed networking functionality. More...

Detailed Description

The primary interface to stubbed networking functionality.

Definition at line 28 of file PgeNetworkStub.h.

#include <PgeNetworkStub.h>

Inheritance diagram for pge_network::PgeNetworkStub:

Public Member Functions
	PgeNetworkStub (PGEcfgProfiles &cfgProfiles)
	PgeNetworkStub (const PgeNetworkStub &)=delete
PgeNetworkStub &	operator= (const PgeNetworkStub &)=delete
	PgeNetworkStub (PgeNetworkStub &&)=delete
PgeNetworkStub &&	operator= (PgeNetworkStub &&)=delete
virtual	~PgeNetworkStub ()
bool	initialize () override
	Initialize the networking subsystem.
bool	shutdown () override
	Stops the networking subsystem.
bool	isInitialized () const override
	Gets the state of the networking subsystem.
bool	reinitialize () override
	Stop and then initialize the networking subsystem.
void	disconnect (const std::string &) override
	Disconnects the initialized networking subsystem.
bool	isServer () const override
	Returns whether the initialized network subsystem should be the server instance.
void	Update () override
	Handles connection state changes and forwards messages to the application.
pge_network::PgeIServerClient *	getServerClientInstance () override
	Returns access to the initialized networking subsystem.
pge_network::PgeIClient &	getClient () override
	Returns the client instance.
pge_network::PgeIServer &	getServer () override
	Returns the server instance.
void	WriteList () const override
	Writes statistics to console.
Public Member Functions inherited from pge_network::PgeINetwork

Private Attributes
PGEcfgProfiles &	m_cfgProfiles
pge_network::PgeIServerClient *	m_pServerClient {nullptr}
pge_network::PgeClientStub	m_client
pge_network::PgeServerStub	m_server
pge_network::PgeIClient &	m_iclient { m_client }
pge_network::PgeIServer &	m_iserver { m_server }
bool	m_bServer {false}

Additional Inherited Members
Static Public Member Functions inherited from pge_network::PgeINetwork
static const char *	getLoggerModuleName ()
	Returns the logger module name of this class.
Static Public Attributes inherited from pge_network::PgeINetwork
static constexpr char *	CVAR_NET_SERVER = "net_server"

Constructor & Destructor Documentation

PgeNetworkStub() [1/3]

pge_network::PgeNetworkStub::PgeNetworkStub ( PGEcfgProfiles & cfgProfiles )

inline

Definition at line 35 of file PgeNetworkStub.h.

PgeNetworkStub() [2/3]

pge_network::PgeNetworkStub::PgeNetworkStub ( const PgeNetworkStub & )

delete

PgeNetworkStub() [3/3]

pge_network::PgeNetworkStub::PgeNetworkStub ( PgeNetworkStub && )

delete

~PgeNetworkStub()

virtual pge_network::PgeNetworkStub::~PgeNetworkStub ( )

inlinevirtual

Definition at line 48 of file PgeNetworkStub.h.

Member Function Documentation

disconnect()

void pge_network::PgeNetworkStub::disconnect ( const std::string & sExtraDebugText )

inlineoverridevirtual

Disconnects the initialized networking subsystem.

Implements pge_network::PgeINetwork.

Definition at line 100 of file PgeNetworkStub.h.

getClient()

pge_network::PgeIClient & pge_network::PgeNetworkStub::getClient ( )

inlineoverridevirtual

Returns the client instance.

Implements pge_network::PgeINetwork.

Definition at line 110 of file PgeNetworkStub.h.

getServer()

pge_network::PgeIServer & pge_network::PgeNetworkStub::getServer ( )

inlineoverridevirtual

Returns the server instance.

Implements pge_network::PgeINetwork.

Definition at line 111 of file PgeNetworkStub.h.

getServerClientInstance()

pge_network::PgeIServerClient * pge_network::PgeNetworkStub::getServerClientInstance ( )

inlineoverridevirtual

Returns access to the initialized networking subsystem.

Implements pge_network::PgeINetwork.

Definition at line 109 of file PgeNetworkStub.h.

initialize()

bool pge_network::PgeNetworkStub::initialize ( )

inlineoverridevirtual

Initialize the networking subsystem.

Implements pge_network::PgeINetwork.

Definition at line 53 of file PgeNetworkStub.h.

isInitialized()

bool pge_network::PgeNetworkStub::isInitialized ( ) const

inlineoverridevirtual

Gets the state of the networking subsystem.

Implements pge_network::PgeINetwork.

Definition at line 86 of file PgeNetworkStub.h.

isServer()

bool pge_network::PgeNetworkStub::isServer ( ) const

inlineoverridevirtual

Returns whether the initialized network subsystem should be the server instance.

Implements pge_network::PgeINetwork.

Definition at line 102 of file PgeNetworkStub.h.

operator=() [1/2]

PgeNetworkStub & pge_network::PgeNetworkStub::operator= ( const PgeNetworkStub & )

delete

operator=() [2/2]

PgeNetworkStub && pge_network::PgeNetworkStub::operator= ( PgeNetworkStub && )

delete

reinitialize()

bool pge_network::PgeNetworkStub::reinitialize ( )

inlineoverridevirtual

Stop and then initialize the networking subsystem.

Implements pge_network::PgeINetwork.

Definition at line 91 of file PgeNetworkStub.h.

shutdown()

bool pge_network::PgeNetworkStub::shutdown ( )

inlineoverridevirtual

Stops the networking subsystem.

Implements pge_network::PgeINetwork.

Definition at line 76 of file PgeNetworkStub.h.

Update()

void pge_network::PgeNetworkStub::Update ( )

inlineoverridevirtual

Handles connection state changes and forwards messages to the application.

Implements pge_network::PgeINetwork.

Definition at line 107 of file PgeNetworkStub.h.

WriteList()

void pge_network::PgeNetworkStub::WriteList ( ) const

inlineoverridevirtual

Writes statistics to console.

Implements pge_network::PgeINetwork.

Definition at line 113 of file PgeNetworkStub.h.

Member Data Documentation

m_bServer

bool pge_network::PgeNetworkStub::m_bServer {false}

private

Definition at line 123 of file PgeNetworkStub.h.

m_cfgProfiles

PGEcfgProfiles& pge_network::PgeNetworkStub::m_cfgProfiles

private

Definition at line 117 of file PgeNetworkStub.h.

m_client

pge_network::PgeClientStub pge_network::PgeNetworkStub::m_client

private

Definition at line 119 of file PgeNetworkStub.h.

m_iclient

pge_network::PgeIClient& pge_network::PgeNetworkStub::m_iclient { m_client }

private

Definition at line 121 of file PgeNetworkStub.h.

m_iserver

pge_network::PgeIServer& pge_network::PgeNetworkStub::m_iserver { m_server }

private

Definition at line 122 of file PgeNetworkStub.h.

m_pServerClient

pge_network::PgeIServerClient* pge_network::PgeNetworkStub::m_pServerClient {nullptr}

private

Definition at line 118 of file PgeNetworkStub.h.

m_server

pge_network::PgeServerStub pge_network::PgeNetworkStub::m_server

private

Definition at line 120 of file PgeNetworkStub.h.

---

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

• C:/__PR00F__/___developing___/projects/PGE/PGE/Network/Stubs/PgeNetworkStub.h