Multiplayer::SessionNotifications Class Reference

#include <SessionNotifications.h>

Inherits AZ::EBusTraits.

Public Types
using	MutexType = AZStd::recursive_mutex

Public Member Functions
virtual bool	OnSessionHealthCheck ()=0
virtual bool	OnCreateSessionBegin (const SessionConfig &sessionConfig)=0
virtual void	OnCreateSessionEnd ()=0
virtual bool	OnDestroySessionBegin ()=0
virtual void	OnDestroySessionEnd ()=0
virtual void	OnUpdateSessionBegin (const SessionConfig &sessionConfig, const AZStd::string &updateReason)=0
virtual void	OnUpdateSessionEnd ()=0

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::Single

Detailed Description

SessionNotifications The session notifications to listen for performing required operations

Member Function Documentation

OnCreateSessionBegin()

virtual bool Multiplayer::SessionNotifications::OnCreateSessionBegin ( const SessionConfig &  sessionConfig )

pure virtual

OnCreateSessionBegin is fired at the beginning of session creation process Use this notification to perform any necessary configuration or initialization before creating session

Parameters

sessionConfig

The properties to describe a session

Returns

True if OnCreateSessionBegin succeeds, false otherwise

OnCreateSessionEnd()

virtual void Multiplayer::SessionNotifications::OnCreateSessionEnd ( )

pure virtual

OnCreateSessionEnd is fired at the end of session creation process Use this notification to perform any follow-up operation after session is created and active

OnDestroySessionBegin()

virtual bool Multiplayer::SessionNotifications::OnDestroySessionBegin ( )

pure virtual

OnDestroySessionBegin is fired at the beginning of session termination process Use this notification to perform any cleanup operation before destroying session, like gracefully disconnect players, cleanup data, etc.

Returns

True if OnDestroySessionBegin succeeds, false otherwise

OnDestroySessionEnd()

virtual void Multiplayer::SessionNotifications::OnDestroySessionEnd ( )

pure virtual

OnDestroySessionEnd is fired at the end of session termination process Use this notification to perform any follow-up operation after session is destroyed, like shutdown application process, etc.

OnSessionHealthCheck()

virtual bool Multiplayer::SessionNotifications::OnSessionHealthCheck ( )

pure virtual

OnSessionHealthCheck is fired in health check process Use this notification to perform any custom health check

Returns

True if OnSessionHealthCheck succeeds, false otherwise

OnUpdateSessionBegin()

virtual void Multiplayer::SessionNotifications::OnUpdateSessionBegin ( const SessionConfig &  sessionConfig, const AZStd::string &  updateReason  )

pure virtual

OnUpdateSessionBegin is fired at the beginning of session update process Use this notification to perform any configuration or initialization to handle the session settings changing

Parameters

sessionConfig	The properties to describe a session
updateReason	The reason for session update

OnUpdateSessionEnd()

virtual void Multiplayer::SessionNotifications::OnUpdateSessionEnd ( )

pure virtual

OnUpdateSessionBegin is fired at the end of session update process Use this notification to perform any follow-up operations after session is updated

---

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

• Gems/Multiplayer/Code/Include/Multiplayer/Session/SessionNotifications.h