Multiplayer::StandardMultiplayerServer Class Reference

#include <standardmultiplayerserver.h>

Detailed Description

Copyright

(C) 2025 Individual contributors, see AUTHORS file

Inherits Multiplayer::BaseMultiplayerServer.

Public Member Functions
	StandardMultiplayerServer ()
	~StandardMultiplayerServer ()
bool	Open () override
	open the server
void	Close () override
	close the server
bool	OnClientIsConnecting (ClientConnection *connection) override
	Called when client is trying to connect. Override and return true if the connection should be accepted.
void	OnClientConnected (ClientConnection *connection) override
	Called when client has successfully connected to the server.
void	OnClientDisconnected (ClientConnection *connection) override
	Called when client has disconnected from the server.
void	OnMessageReceived (ClientConnection *connection, Timing::Time recvTime, byte *data, size_t size) override
	Called when a message has been received from a client.
void	OnTick () override
	Called every tickInterval seconds, after OnFrame.
void	OnFrame () override
	Called every "frame".
Public Member Functions inherited from Multiplayer::BaseMultiplayerServer
	BaseMultiplayerServer ()
	constructor
virtual	~BaseMultiplayerServer ()
	destructor
bool	IsOpen () const
	return true if server is open
void	Broadcast (void *buf, int size)
	broadcast message to all clients
Timing::Time	GetTickInterval () const
	Returns the interval between ticks, in seconds.
void	SetTickInterval (Timing::Time interval)
	Sets the interval (seconds) between ticks.
void	SetClientGroupPollInterval (ClientGroup group, Timing::Time msBetweenTicks)
void	SyncAll ()
	Checks for connection changes, polls messages and calls OnFrame/OnTick.
void	OnNetConnectionStatusChanged (SteamNetConnectionStatusChangedCallback_t *info)
	Used internally by GameNetworkingSockets at connection status changes.

Additional Inherited Members
Public Attributes inherited from Multiplayer::BaseMultiplayerServer
SizeT	maxMessagesPerFrame = 1024
Protected Member Functions inherited from Multiplayer::BaseMultiplayerServer
void	AddClientConnection (ClientConnection *connection)
	add a client connection (called by the listener thread)
void	PollIncomingMessages ()
void	PollConnectionChanges ()
Protected Attributes inherited from Multiplayer::BaseMultiplayerServer
friend	ClientConnection
bool	isOpen
Util::HashTable< HSteamNetConnection, ClientConnection *, 128 >	clientConnections
ISteamNetworkingSockets *	netInterface
HSteamListenSocket	listenSock
HSteamNetPollGroup	pollGroups [(int) ClientGroup::NumClientGroups]
Timing::Timer	pollGroupTimers [(int) ClientGroup::NumClientGroups]
Timing::Time	pollGroupIntervals [(int) ClientGroup::NumClientGroups]
Timing::Timer	tickTimer
Timing::Time	tickInterval

Constructor & Destructor Documentation

StandardMultiplayerServer()

Multiplayer::StandardMultiplayerServer::StandardMultiplayerServer ( )

inline

~StandardMultiplayerServer()

Multiplayer::StandardMultiplayerServer::~StandardMultiplayerServer ( )

inline

Member Function Documentation

Close()

void Multiplayer::StandardMultiplayerServer::Close ( )

overridevirtual

close the server

Reimplemented from Multiplayer::BaseMultiplayerServer.

OnClientConnected()

void Multiplayer::StandardMultiplayerServer::OnClientConnected ( ClientConnection * connection )

overridevirtual

Called when client has successfully connected to the server.

Reimplemented from Multiplayer::BaseMultiplayerServer.

OnClientDisconnected()

void Multiplayer::StandardMultiplayerServer::OnClientDisconnected ( ClientConnection * connection )

overridevirtual

Called when client has disconnected from the server.

Reimplemented from Multiplayer::BaseMultiplayerServer.

OnClientIsConnecting()

bool Multiplayer::StandardMultiplayerServer::OnClientIsConnecting ( ClientConnection * connection )

overridevirtual

Called when client is trying to connect. Override and return true if the connection should be accepted.

Reimplemented from Multiplayer::BaseMultiplayerServer.

OnFrame()

void Multiplayer::StandardMultiplayerServer::OnFrame ( )

overridevirtual

Called every "frame".

Reimplemented from Multiplayer::BaseMultiplayerServer.

OnMessageReceived()

void Multiplayer::StandardMultiplayerServer::OnMessageReceived ( ClientConnection * connection, Timing::Time recvTime, byte * data, size_t size )

overridevirtual

Called when a message has been received from a client.

Reimplemented from Multiplayer::BaseMultiplayerServer.

OnTick()

void Multiplayer::StandardMultiplayerServer::OnTick ( )

overridevirtual

Called every tickInterval seconds, after OnFrame.

Reimplemented from Multiplayer::BaseMultiplayerServer.

Open()

bool Multiplayer::StandardMultiplayerServer::Open ( )

overridevirtual

open the server

Reimplemented from Multiplayer::BaseMultiplayerServer.

---

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

• /github/workspace/code/addons/multiplayer/server/standardmultiplayerserver.h
• /github/workspace/code/addons/multiplayer/server/standardmultiplayerserver.cc