PGE API 0.4
PR00F's Game Engine full documentation
Loading...
Searching...
No Matches
pge_network::PgeNetwork Class Reference

The primary interface to networking functionality. More...

Detailed Description

The primary interface to networking functionality.

Singleton, can be instantiated with static createAndGet().

Definition at line 29 of file PgeNetwork.h.

#include <PgeNetwork.h>

+ Inheritance diagram for pge_network::PgeNetwork:

Public Member Functions

CConsole & getConsole () const
 Returns access to console preset with logger module name as this class.
 
- Public Member Functions inherited from pge_network::PgeINetwork
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 PgeIServerClientgetServerClientInstance ()=0
 Returns access to the initialized networking subsystem.
 
virtual PgeIClientgetClient ()=0
 Returns the client instance.
 
virtual PgeIServergetServer ()=0
 Returns the server instance.
 
virtual void WriteList () const =0
 Writes statistics to console.
 

Static Public Member Functions

static PgeINetworkcreateAndGet (PGEcfgProfiles &cfgProfiles)
 Creates and gets the singleton implementation instance.
 
- Static Public Member Functions inherited from pge_network::PgeINetwork
static const char * getLoggerModuleName ()
 Returns the logger module name of this class.
 

Additional Inherited Members

- Static Public Attributes inherited from pge_network::PgeINetwork
static constexpr char * CVAR_NET_SERVER = "net_server"
 

Member Function Documentation

◆ createAndGet()

pge_network::PgeINetwork & pge_network::PgeNetwork::createAndGet ( PGEcfgProfiles & cfgProfiles)
static

Creates and gets the singleton implementation instance.

Creates and gets the singleton instance.

Definition at line 309 of file PgeNetwork.cpp.

◆ getConsole()

CConsole & pge_network::PgeNetwork::getConsole ( ) const

Returns access to console preset with logger module name as this class.

Intentionally not virtual, so the getConsole() in derived class should hide this instead of overriding.

Returns
Console instance used by this class.

Definition at line 322 of file PgeNetwork.cpp.


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