Multiplayer::ClientConnection Class Reference

#include <clientconnection.h>

Detailed Description

Copyright

(C) 2025 Individual contributors, see AUTHORS file

Public Member Functions
	ClientConnection ()
	constructor
virtual	~ClientConnection ()
	destructor
void	Initialize (BaseMultiplayerServer *server, HSteamNetConnection connectionId)
bool	IsConnected () const
	get the connection status
virtual void	Shutdown ()
	shutdown the connection
void	SetClientGroup (ClientGroup group)
ClientGroup	GetClientGroup () const
uint32_t	GetConnectionId () const
Timing::Time	GetCurrentPing () const
	Gets the estimated current packet roundtrip time (server->client->server).
uint64_t	GetUserData () const
void	SetUserData (uint64_t)

Protected Attributes
BaseMultiplayerServer *	server
ClientGroup	group = ClientGroup::DontCare
HSteamNetConnection	connectionId = k_HSteamNetConnection_Invalid
uint64_t	userData

Constructor & Destructor Documentation

ClientConnection()

Multiplayer::ClientConnection::ClientConnection

(

)

constructor

~ClientConnection()

Multiplayer::ClientConnection::~ClientConnection ( )

virtual

destructor

Member Function Documentation

GetClientGroup()

ClientGroup Multiplayer::ClientConnection::GetClientGroup ( ) const

inline

GetConnectionId()

uint32_t Multiplayer::ClientConnection::GetConnectionId ( ) const

inline

GetCurrentPing()

Timing::Time Multiplayer::ClientConnection::GetCurrentPing

(

)

const

Gets the estimated current packet roundtrip time (server->client->server).

GetUserData()

uint64_t Multiplayer::ClientConnection::GetUserData ( ) const

inline

Initialize()

void Multiplayer::ClientConnection::Initialize	(	BaseMultiplayerServer *	server,
		HSteamNetConnection	connectionId )

IsConnected()

bool Multiplayer::ClientConnection::IsConnected

(

)

const

get the connection status

SetClientGroup()

void Multiplayer::ClientConnection::SetClientGroup

(

ClientGroup

group

)

SetUserData()

void Multiplayer::ClientConnection::SetUserData ( uint64_t data )

inline

Shutdown()

void Multiplayer::ClientConnection::Shutdown ( )

virtual

shutdown the connection

Member Data Documentation

connectionId

HSteamNetConnection Multiplayer::ClientConnection::connectionId = k_HSteamNetConnection_Invalid

protected

group

ClientGroup Multiplayer::ClientConnection::group = ClientGroup::DontCare

protected

server

BaseMultiplayerServer* Multiplayer::ClientConnection::server

protected

userData

uint64_t Multiplayer::ClientConnection::userData

protected

---

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

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