GOG GALAXY SDK Documentation
IConnectionOpenListener Class Referenceabstract

Listener for the events related to opening a connection. More...

#include <ICustomNetworking.h>

Inheritance diagram for IConnectionOpenListener:
[legend]

Public Types

enum  FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_CONNECTION_FAILURE , FAILURE_REASON_UNAUTHORIZED }
 The reason of a failure in opening a connection. More...
 

Public Member Functions

virtual void OnConnectionOpenSuccess (const char *connectionString, ConnectionID connectionID)=0
 Notification for the event of a success in opening a connection. More...
 
virtual void OnConnectionOpenFailure (const char *connectionString, FailureReason failureReason)=0
 Notification for the event of a failure in opening a connection. More...
 

Additional Inherited Members

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

Detailed Description

Listener for the events related to opening a connection.

Member Enumeration Documentation

◆ FailureReason

The reason of a failure in opening a connection.

Enumerator
FAILURE_REASON_UNDEFINED 

Unspecified error.

FAILURE_REASON_CONNECTION_FAILURE 

Unable to communicate with backend services.

FAILURE_REASON_UNAUTHORIZED 

Client is unauthorized.

Member Function Documentation

◆ OnConnectionOpenFailure()

virtual void OnConnectionOpenFailure ( const char *  connectionString,
FailureReason  failureReason 
)
pure virtual

Notification for the event of a failure in opening a connection.

Parameters
[in]connectionStringThe connection string.
[in]failureReasonThe cause of the failure.

◆ OnConnectionOpenSuccess()

virtual void OnConnectionOpenSuccess ( const char *  connectionString,
ConnectionID  connectionID 
)
pure virtual

Notification for the event of a success in opening a connection.

Parameters
[in]connectionStringThe connection string.
[in]connectionIDThe ID if the connection.