pge_network::PgeINetwork Class Reference

The primary interface to networking functionality. More...

Detailed Description

The primary interface to networking functionality.

Definition at line 25 of file PgeINetwork.h.

#include <PgeINetwork.h>

Inheritance diagram for pge_network::PgeINetwork:

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

Static Public Member Functions
static const char *	getLoggerModuleName ()
	Returns the logger module name of this class.

Static Public Attributes
static constexpr char *	CVAR_NET_SERVER = "net_server"

Member Function Documentation

disconnect()

virtual void pge_network::PgeINetwork::disconnect ( const std::string & sExtraDebugText )

pure virtual

Disconnects the initialized networking subsystem.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

getClient()

virtual PgeIClient & pge_network::PgeINetwork::getClient ( )

pure virtual

Returns the client instance.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

getLoggerModuleName()

static const char * pge_network::PgeINetwork::getLoggerModuleName ( )

inlinestatic

Returns the logger module name of this class.

Not private, so user can also access this from outside, for any reason like controlling log filtering per logger module name.

Returns

The logger module name of this class.

Definition at line 41 of file PgeINetwork.h.

getServer()

virtual PgeIServer & pge_network::PgeINetwork::getServer ( )

pure virtual

Returns the server instance.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

getServerClientInstance()

virtual PgeIServerClient * pge_network::PgeINetwork::getServerClientInstance ( )

pure virtual

Returns access to the initialized networking subsystem.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

initialize()

virtual bool pge_network::PgeINetwork::initialize ( )

pure virtual

Initialize the networking subsystem.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

isInitialized()

virtual bool pge_network::PgeINetwork::isInitialized ( ) const

pure virtual

Gets the state of the networking subsystem.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

isServer()

virtual bool pge_network::PgeINetwork::isServer ( ) const

pure virtual

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

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

reinitialize()

virtual bool pge_network::PgeINetwork::reinitialize ( )

pure virtual

Stop and then initialize the networking subsystem.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

shutdown()

virtual bool pge_network::PgeINetwork::shutdown ( )

pure virtual

Stops the networking subsystem.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

Update()

virtual void pge_network::PgeINetwork::Update ( )

pure virtual

Handles connection state changes and forwards messages to the application.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

WriteList()

virtual void pge_network::PgeINetwork::WriteList ( ) const

pure virtual

Writes statistics to console.

Implemented in pge_network::PgeNetworkStub, and PgeNetworkImpl.

Member Data Documentation

CVAR_NET_SERVER

char* pge_network::PgeINetwork::CVAR_NET_SERVER = "net_server"

staticconstexpr

Definition at line 33 of file PgeINetwork.h.

---

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

• C:/__PR00F__/___developing___/projects/PGE/PGE/Network/PgeINetwork.h