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.
Multiplayer::SessionAsyncRequestNotifications Class Referenceabstract

#include <ISessionRequests.h>

Inherits AZ::EBusTraits.

Public Types

using MutexType = AZStd::recursive_mutex
 

Public Member Functions

virtual void OnCreateSessionAsyncComplete (const AZStd::string &createSessionReponse)=0
 
virtual void OnSearchSessionsAsyncComplete (const SearchSessionsResponse &searchSessionsResponse)=0
 
virtual void OnJoinSessionAsyncComplete (bool joinSessionsResponse)=0
 
virtual void OnLeaveSessionAsyncComplete ()=0
 OnLeaveSessionAsyncComplete is fired once LeaveSessionAsync completes.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Detailed Description

SessionAsyncRequestNotifications The notifications correspond to session async requests

Member Function Documentation

◆ OnCreateSessionAsyncComplete()

virtual void Multiplayer::SessionAsyncRequestNotifications::OnCreateSessionAsyncComplete ( const AZStd::string &  createSessionReponse)
pure virtual

OnCreateSessionAsyncComplete is fired once CreateSessionAsync completes

Parameters
createSessionResponseThe request id if session creation request succeeds; empty if it fails

◆ OnJoinSessionAsyncComplete()

virtual void Multiplayer::SessionAsyncRequestNotifications::OnJoinSessionAsyncComplete ( bool  joinSessionsResponse)
pure virtual

OnJoinSessionAsyncComplete is fired once JoinSessionAsync completes

Parameters
joinSessionsResponseTrue if joining session succeeds; False otherwise

◆ OnSearchSessionsAsyncComplete()

virtual void Multiplayer::SessionAsyncRequestNotifications::OnSearchSessionsAsyncComplete ( const SearchSessionsResponse searchSessionsResponse)
pure virtual

OnSearchSessionsAsyncComplete is fired once SearchSessionsAsync completes

Parameters
searchSessionsResponseThe response of SearchSessions call

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