Multiplayer::ISessionRequests Class Reference

#include <ISessionRequests.h>

Public Member Functions
	AZ_RTTI (ISessionRequests, "{D6C41A71-DD8D-47FE-8515-FAF90670AE2F}")
virtual AZStd::string	CreateSession (const CreateSessionRequest &createSessionRequest)=0
virtual SearchSessionsResponse	SearchSessions (const SearchSessionsRequest &searchSessionsRequest) const =0
virtual bool	JoinSession (const JoinSessionRequest &joinSessionRequest)=0
virtual void	LeaveSession ()=0
	Disconnect player from session.

Detailed Description

ISessionRequests Pure virtual session interface class to abstract the details of session handling from application code.

Member Function Documentation

CreateSession()

virtual AZStd::string Multiplayer::ISessionRequests::CreateSession ( const CreateSessionRequest &  createSessionRequest )

pure virtual

Create a session for players to find and join.

Parameters

createSessionRequest

The request of CreateSession operation

Returns

The request id if session creation request succeeds; empty if it fails

JoinSession()

virtual bool Multiplayer::ISessionRequests::JoinSession ( const JoinSessionRequest &  joinSessionRequest )

pure virtual

Reserve an open player slot in a session, and perform connection from client to server.

Parameters

joinSessionRequest

The request of JoinSession operation

Returns

True if joining session succeeds; False otherwise

SearchSessions()

virtual SearchSessionsResponse Multiplayer::ISessionRequests::SearchSessions ( const SearchSessionsRequest &  searchSessionsRequest ) const

pure virtual

Retrieve all active sessions that match the given search criteria and sorted in specific order.

Parameters

searchSessionsRequest

The request of SearchSessions operation

Returns

The response of SearchSessions operation

---

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

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