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

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

Detailed Description

The primary interface to server networking functionality.

Singleton, can be instantiated with static createAndGet().

Definition at line 28 of file PgeServer.h.

#include <PgeServer.h>

+ Inheritance diagram for pge_network::PgeServer:

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::PgeIServer
virtual bool startListening (const std::string &sAppVersion="")=0
 Starts listening to incoming PgeClient connections.
 
virtual void sendToAllClientsExcept (const pge_network::PgePacket &pkt, const pge_network::PgeNetworkConnectionHandle &exceptConnHandle=pge_network::ServerConnHandle)=0
 Sends the given packet to all client instances except the optionally specified client.
 
virtual void sendToAll (const pge_network::PgePacket &pkt)=0
 Sends the given packet to all known network instances, including the server itself (self).
 
virtual void setDebugNickname (const pge_network::PgeNetworkConnectionHandle &connHandle, const std::string &sNickname)=0
 Sets a debug helper name associated to the given connection handle.
 
virtual int getPing (const pge_network::PgeNetworkConnectionHandle &connHandle, bool bForceUpdate)=0
 
virtual float getQualityLocal (const pge_network::PgeNetworkConnectionHandle &connHandle, bool bForceUpdate)=0
 
virtual float getQualityRemote (const pge_network::PgeNetworkConnectionHandle &connHandle, bool bForceUpdate)=0
 
virtual float getRxByteRate (const pge_network::PgeNetworkConnectionHandle &connHandle, bool bForceUpdate)=0
 
virtual float getTxByteRate (const pge_network::PgeNetworkConnectionHandle &connHandle, bool bForceUpdate)=0
 
virtual int64_t getPendingUnreliableBytes (const pge_network::PgeNetworkConnectionHandle &connHandle, bool bForceUpdate)=0
 
virtual int64_t getPendingReliableBytes (const pge_network::PgeNetworkConnectionHandle &connHandle, bool bForceUpdate)=0
 
virtual int64_t getSentButUnAckedReliableBytes (const pge_network::PgeNetworkConnectionHandle &connHandle, bool bForceUpdate)=0
 
virtual int64_t getInternalQueueTimeUSecs (const pge_network::PgeNetworkConnectionHandle &connHandle, bool bForceUpdate)=0
 
virtual std::string getDetailedConnectionStatus (const pge_network::PgeNetworkConnectionHandle &connHandle) const =0
 
- Public Member Functions inherited from pge_network::PgeIServerClient
virtual bool initialize ()=0
 Initialize the network instance.
 
virtual bool shutdown ()=0
 This stops the network instance.
 
virtual bool isInitialized () const =0
 Gets the state of the network instance.
 
virtual void disconnect (const std::string &sExtraDebugText="")=0
 Terminates the active connection of the network instance.
 
virtual void Update ()=0
 
virtual bool pollIncomingMessages ()=0
 Moves incoming packets from the underlying network layer to PGE network layer as PgePackets.
 
virtual void pollConnectionStateChanges ()=0
 
virtual std::size_t getPacketQueueSize () const =0
 
virtual pge_network::PgePacket popFrontPacket () noexcept(false)=0
 
virtual std::set< pge_network::PgePktId > & getAllowListedPgeMessages ()=0
 
virtual std::set< pge_network::MsgApp::TMsgId > & getAllowListedAppMessages ()=0
 
virtual void send (const pge_network::PgePacket &pkt, const pge_network::PgeNetworkConnectionHandle &connHandle=pge_network::ServerConnHandle)=0
 Sends the given packet to the network instance specified.
 
virtual uint32_t getRxPacketCount () const =0
 
virtual uint32_t getTxPacketCount () const =0
 
virtual uint32_t getInjectPacketCount () const =0
 
virtual uint32_t getRxPacketPerSecondCount () const =0
 
virtual uint32_t getTxPacketPerSecondCount () const =0
 
virtual uint32_t getInjectPacketPerSecondCount () const =0
 
virtual const std::map< pge_network::MsgApp::TMsgId, uint32_t > & getRxMsgCount () const =0
 
virtual const std::map< pge_network::MsgApp::TMsgId, uint32_t > & getTxMsgCount () const =0
 
virtual const std::map< pge_network::MsgApp::TMsgId, uint32_t > & getInjectMsgCount () const =0
 
virtual std::map< pge_network::MsgApp::TMsgId, std::string > & getMsgAppId2StringMap ()=0
 
virtual uint32_t getRxByteCount () const =0
 
virtual uint32_t getTxByteCount () const =0
 
virtual uint32_t getInjectByteCount () const =0
 
virtual void WriteList () const =0
 Writes statistics to console.
 

Static Public Member Functions

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

Member Function Documentation

◆ createAndGet()

pge_network::PgeIServer & pge_network::PgeServer::createAndGet ( PGEcfgProfiles & cfgProfiles)
static

Creates and gets the singleton implementation instance.

Creates and gets the singleton instance.

Definition at line 426 of file PgeServer.cpp.

◆ getConsole()

CConsole & pge_network::PgeServer::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 439 of file PgeServer.cpp.


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