ILobbyDataRetrieveListener Class Reference

Listener for the event of retrieving lobby data. More...

#include <IMatchmaking.h>

Inheritance diagram for ILobbyDataRetrieveListener:

Public Types
enum	FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_LOBBY_DOES_NOT_EXIST , FAILURE_REASON_CONNECTION_FAILURE }
	The reason of a failure in retrieving lobby data. More...

Public Member Functions
virtual void	OnLobbyDataRetrieveSuccess (const GalaxyID &lobbyID)=0
	Notification for the event of success in retrieving lobby data. More...
virtual void	OnLobbyDataRetrieveFailure (const GalaxyID &lobbyID, FailureReason failureReason)=0
	Notification for the event of a failure in retrieving lobby data. More...

Additional Inherited Members
Static Public Member Functions inherited from GalaxyTypeAwareListener< LOBBY_DATA_RETRIEVE >
static ListenerType	GetListenerType ()
	Returns the type of the listener. More...

Detailed Description

Listener for the event of retrieving lobby data.

Member Enumeration Documentation

FailureReason

enum FailureReason

The reason of a failure in retrieving lobby data.

Enumerator
FAILURE_REASON_UNDEFINED	Unspecified error.
FAILURE_REASON_LOBBY_DOES_NOT_EXIST	Specified lobby does not exist.
FAILURE_REASON_CONNECTION_FAILURE	Unable to communicate with backend services.

Member Function Documentation

OnLobbyDataRetrieveFailure()

virtual void OnLobbyDataRetrieveFailure ( const GalaxyID &  lobbyID, FailureReason  failureReason  )

pure virtual

Notification for the event of a failure in retrieving lobby data.

Parameters

[in]	lobbyID	The ID of the lobby.
[in]	failureReason	The cause of the failure.

OnLobbyDataRetrieveSuccess()

virtual void OnLobbyDataRetrieveSuccess ( const GalaxyID &  lobbyID )

pure virtual

Notification for the event of success in retrieving lobby data.

Parameters

[in]

lobbyID

The ID of the lobby.