GOG GALAXY SDK Documentation
ILobbyDataUpdateListener Class Referenceabstract

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

#include <IMatchmaking.h>

Inheritance diagram for ILobbyDataUpdateListener:
[legend]

Public Types

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

Public Member Functions

virtual void OnLobbyDataUpdateSuccess (const GalaxyID &lobbyID)=0
 Notification for the event of success in updating lobby data. More...
 
virtual void OnLobbyDataUpdateFailure (const GalaxyID &lobbyID, FailureReason failureReason)=0
 Notification for the failure in updating lobby data. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from GalaxyTypeAwareListener< LOBBY_DATA_UPDATE_LISTENER >
static ListenerType GetListenerType ()
 Returns the type of the listener. More...
 

Detailed Description

Listener for the event of updating lobby data.

Member Enumeration Documentation

◆ FailureReason

The reason of a failure in updating 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

◆ OnLobbyDataUpdateFailure()

virtual void OnLobbyDataUpdateFailure ( const GalaxyID lobbyID,
FailureReason  failureReason 
)
pure virtual

Notification for the failure in updating lobby data.

Parameters
[in]lobbyIDThe ID of the lobby.
[in]failureReasonThe cause of the failure.

◆ OnLobbyDataUpdateSuccess()

virtual void OnLobbyDataUpdateSuccess ( const GalaxyID lobbyID)
pure virtual

Notification for the event of success in updating lobby data.

Parameters
[in]lobbyIDThe ID of the lobby.