GridMate::GridSessionCallbacks Class Reference

#include <Session.h>

Inherits GridMate::GridMateEBusTraits.

Public Member Functions
virtual void	OnSessionServiceReady ()
	Callback that is called when the Session service is ready to process sessions.
virtual void	OnGridSearchStart (GridSearch *gridSearch)
	Callback when we start a grid search.
virtual void	OnGridSearchComplete (GridSearch *gridSearch)
	Callback that notifies the title when a game search query have completed.
virtual void	OnGridSearchRelease (GridSearch *gridSearch)
	Callback when we release (delete) a grid search. It's not safe to hold the grid pointer after this.
virtual void	OnMemberJoined (GridSession *session, GridMember *member)
	Callback that notifies the title when a new member joins the game session.
virtual void	OnMemberLeaving (GridSession *session, GridMember *member)
	Callback that notifies the title that a member is leaving the game session. member pointer is NOT valid after the callback returns.
virtual void	OnMemberKicked (GridSession *session, GridMember *member, AZ::u8 reason)
	Callback that host decided to kick a member. You will receive a OnMemberLeaving when the actual member leaves the session.
virtual void	OnSessionCreated (GridSession *session)
	Called when new session is created. Client session might not sync yet at this point.
virtual void	OnSessionHosted (GridSession *session)
	After this callback it is safe to access session features. Host session is fully operational.
virtual void	OnSessionJoined (GridSession *session)
	After this callback it is safe to access session features. Client session is fully operational.
virtual void	OnSessionDelete (GridSession *session)
	Callback that notifies the title when a session will be left. session pointer is NOT valid after the callback returns.
virtual void	OnSessionError (GridSession *session, const AZStd::string &errorMsg)
	Called when a session error occurs.
virtual void	OnSessionStart (GridSession *session)
	Called when the actual game(match) starts.
virtual void	OnSessionEnd (GridSession *session)
	Called when the actual game(match) ends.
virtual void	OnMigrationStart (GridSession *session)
	Called when we start a host migration.
virtual void	OnMigrationElectHost (GridSession *session, GridMember *&newHost)
	Called so the user can select a member that should be the new Host. Value will be ignored if NULL, current host or the member has invalid connection id.
virtual void	OnMigrationEnd (GridSession *session, GridMember *newHost)
	Called when the host migration has completed.
virtual void	OnWriteStatistics (GridSession *session, GridMember *member, StatisticsData &data)
	Called when we have our last chance to write statistics data for member in the session.

Additional Inherited Members
Public Types inherited from GridMate::GridMateEBusTraits
typedef AZStd::recursive_mutex	MutexType
	We do allow running multiple instances gridmate on different threads.
typedef IGridMate *	BusIdType
	Use the GridMate instance as an ID.
Static Public Attributes inherited from GridMate::GridMateEBusTraits
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::ById
	Allow multiple instances of gridmate in an unordered_map.

Detailed Description

Grid Session Callbacks

---

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

• Code/Framework/GridMate/GridMate/Session/Session.h