GOG GALAXY SDK Documentation
|
Listener for the event of downloading a file stored in cloud storage. More...
#include <ICloudStorage.h>
Public Types | |
enum | FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_UNAUTHORIZED , FAILURE_REASON_FORBIDDEN , FAILURE_REASON_NOT_FOUND , FAILURE_REASON_UNAVAILABLE , FAILURE_REASON_ABORTED , FAILURE_REASON_CONNECTION_FAILURE , FAILURE_REASON_BUFFER_TOO_SMALL , FAILURE_REASON_WRITE_FUNC_ERROR } |
The reason of a failure in downloading a file. More... | |
Public Member Functions | |
virtual void | OnGetFileSuccess (const char *container, const char *name, uint32_t fileSize, SavegameType savegameType, const char *savegameID)=0 |
Notification for the event of a success in downloading a file. More... | |
virtual void | OnGetFileFailure (const char *container, const char *name, FailureReason failureReason)=0 |
Notification for the event of a failure in downloading a file. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from GalaxyTypeAwareListener< CLOUD_STORAGE_GET_FILE > | |
static ListenerType | GetListenerType () |
Returns the type of the listener. More... | |
Listener for the event of downloading a file stored in cloud storage.
enum FailureReason |
The reason of a failure in downloading a file.
Enumerator | |
---|---|
FAILURE_REASON_UNDEFINED | Unspecified error. |
FAILURE_REASON_UNAUTHORIZED | Authorization lost. |
FAILURE_REASON_FORBIDDEN | No access to specified container. |
FAILURE_REASON_NOT_FOUND | Container not found. |
FAILURE_REASON_UNAVAILABLE | Service unavailable. |
FAILURE_REASON_ABORTED | Request aborted. |
FAILURE_REASON_CONNECTION_FAILURE | Unable to communicate with backend services. |
FAILURE_REASON_BUFFER_TOO_SMALL | Buffer passed to ICloudStorage::GetFile() is too small to fit the file content. |
FAILURE_REASON_WRITE_FUNC_ERROR | Function writeFunc passed to ICloudStorage::GetFile() returned an error. |
|
pure virtual |
Notification for the event of a failure in downloading a file.
[in] | container | The name of the containter. |
[in] | name | The name of the file to be downloaded. |
[in] | failureReason | The cause of the failure. |
|
pure virtual |
Notification for the event of a success in downloading a file.
[in] | container | The name of the containter. |
[in] | name | The name of the file downloaded. |
[in] | fileSize | The size of downloaded data. In case of getting metadata only (GetFileMetadata response) is always zero (no data downloaded). |
[in] | savegameType | The type of the downloaded data (savegame type). |
[in] | savegameID | The ID of the savegame the file belongs to. |