Open 3D Engine Multiplayer Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
Multiplayer::ISessionHandlingProviderRequests Class Referenceabstract

#include <ISessionHandlingRequests.h>

Public Member Functions

 AZ_RTTI (ISessionHandlingProviderRequests, "{4F0C17BA-F470-4242-A8CB-EC7EA805257C}")
 
virtual void HandleDestroySession ()=0
 Handle the destroy session process.
 
virtual bool ValidatePlayerJoinSession (const PlayerConnectionConfig &playerConnectionConfig)=0
 
virtual void HandlePlayerLeaveSession (const PlayerConnectionConfig &playerConnectionConfig)=0
 
virtual AZ::IO::Path GetExternalSessionCertificate ()=0
 

Detailed Description

ISessionProviderRequests Requests made to the service providing server/fleet management by the server

Member Function Documentation

◆ GetExternalSessionCertificate()

virtual AZ::IO::Path Multiplayer::ISessionHandlingProviderRequests::GetExternalSessionCertificate ( )
pure virtual

Retrieves the file location of a pem-encoded TLS certificate for Client to Server communication

Returns
If successful, returns the file location of TLS certificate file; if not successful, returns empty string.

◆ HandlePlayerLeaveSession()

virtual void Multiplayer::ISessionHandlingProviderRequests::HandlePlayerLeaveSession ( const PlayerConnectionConfig &  playerConnectionConfig)
pure virtual

Handle the player leave session process

Parameters
playerConnectionConfigThe required properties to handle the player leave session process

◆ ValidatePlayerJoinSession()

virtual bool Multiplayer::ISessionHandlingProviderRequests::ValidatePlayerJoinSession ( const PlayerConnectionConfig &  playerConnectionConfig)
pure virtual

Validate the player join session process

Parameters
playerConnectionConfigThe required properties to validate the player join session process
Returns
The result of player join session validation
The documentation for this class was generated from the following file: