ICloudStorage.h

Go to the documentation of this file.

#ifndef GALAXY_I_CLOUDSTORAGE_H
#define GALAXY_I_CLOUDSTORAGE_H
 
#include "IListenerRegistrar.h"
 
namespace galaxy
{
    namespace api
    {
        enum SavegameType
        {
            SAVEGAME_TYPE_UNDEFINED, 
            SAVEGAME_TYPE_AUTO, 
            SAVEGAME_TYPE_QUICK, 
            SAVEGAME_TYPE_MANUAL, 
            SAVEGAME_TYPE_POINT_OF_NO_RETURN, 
            SAVEGAME_TYPE_ENDGAME_SAVE, 
            SAVEGAME_TYPE_CHECKPOINT 
        };
 
        class ICloudStorageGetFileListListener : public GalaxyTypeAwareListener<CLOUD_STORAGE_GET_FILE_LIST>
        {
        public:
 
            virtual void OnGetFileListSuccess(uint32_t fileCount, uint32_t quota, uint32_t quotaUsed) = 0;
 
            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 
            };
 
            virtual void OnGetFileListFailure(FailureReason failureReason) = 0;
        };
 
        class ICloudStorageGetFileListener : public GalaxyTypeAwareListener<CLOUD_STORAGE_GET_FILE>
        {
        public:
 
            virtual void OnGetFileSuccess(
                const char* container,
                const char* name,
                uint32_t fileSize,
                SavegameType savegameType,
                const char* savegameID
            ) = 0;
 
            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 
            };
 
            virtual void OnGetFileFailure(const char* container, const char* name, FailureReason failureReason) = 0;
        };
 
        class ICloudStoragePutFileListener : public GalaxyTypeAwareListener<CLOUD_STORAGE_PUT_FILE>
        {
        public:
 
            virtual void OnPutFileSuccess(const char* container, const char* name) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_UNAUTHORIZED, 
                FAILURE_REASON_FORBIDDEN, 
                FAILURE_REASON_UNAVAILABLE, 
                FAILURE_REASON_ABORTED, 
                FAILURE_REASON_CONNECTION_FAILURE, 
                FAILURE_REASON_READ_FUNC_ERROR, 
                FAILURE_REASON_QUOTA_EXCEEDED 
            };
 
            virtual void OnPutFileFailure(const char* container, const char* name, FailureReason failureReason) = 0;
 
        };
 
        class ICloudStorageDeleteFileListener : public GalaxyTypeAwareListener<CLOUD_STORAGE_DELETE_FILE>
        {
        public:
 
            virtual void OnDeleteFileSuccess(const char* container, const char* name) = 0;
 
            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_CONFLICT 
            };
 
            virtual void OnDeleteFileFailure(const char* container, const char* name, FailureReason failureReason) = 0;
        };
 
        class ICloudStorage
        {
        public:
        
            virtual ~ICloudStorage() {}
 
            virtual void GetFileList(const char* container, ICloudStorageGetFileListListener* listener) = 0;
 
            virtual const char* GetFileNameByIndex(uint32_t index) const = 0;
 
            virtual uint32_t GetFileSizeByIndex(uint32_t index) const = 0;
 
            virtual uint32_t GetFileTimestampByIndex(uint32_t index) const = 0;
 
            virtual const char* GetFileHashByIndex(uint32_t index) const = 0;
 
            typedef int (*WriteFunc)(void* userParam, const char* data, int size);
 
            virtual void GetFile(const char* container, const char* name, void* userParam, WriteFunc writeFunc, ICloudStorageGetFileListener* listener) = 0;
 
            virtual void GetFile(const char* container, const char* name, void* dataBuffer, uint32_t bufferLength, ICloudStorageGetFileListener* listener) = 0;
 
            virtual void GetFileMetadata(const char* container, const char* name, ICloudStorageGetFileListener* listener) = 0;
 
            typedef int (*ReadFunc)(void* userParam, char* data, int size);
 
            enum ReadPhase
            {
                CHECKSUM_CALCULATING, 
                UPLOADING 
            };
 
            typedef int (*RewindFunc)(void* userParam, ReadPhase phase);
 
            virtual void PutFile(
                const char* container, 
                const char* name, 
                void* userParam, 
                ReadFunc readFunc, 
                RewindFunc rewindFunc, 
                ICloudStoragePutFileListener* listener,
                SavegameType savegameType = SAVEGAME_TYPE_UNDEFINED,
                uint32_t timeStamp = 0,
                const char* hash = NULL
            ) = 0;
 
            virtual void PutFile(
                const char* container, 
                const char* name, 
                const void* buffer,
                uint32_t bufferLength, 
                ICloudStoragePutFileListener* listener,
                SavegameType savegameType = SAVEGAME_TYPE_UNDEFINED,
                uint32_t timeStamp = 0,
                const char* hash = NULL
            ) = 0;
 
            static const uint32_t MIN_HASH_BUFFER_SIZE = 33;
 
            virtual void CalculateHash(
                void* userParam,
                ReadFunc readFunc,
                RewindFunc rewindFunc,
                char* hashBuffer,
                uint32_t hashBufferSize
            ) = 0;
 
            virtual void CalculateHash(
                const void* buffer,
                uint32_t bufferLength,
                char* hashBuffer,
                uint32_t hashBufferSize
            ) = 0;
 
            virtual void DeleteFile(const char* container, const char* name, ICloudStorageDeleteFileListener* listener, const char* expectedHash = NULL) = 0;
 
            virtual void OpenSavegame() = 0;
 
            virtual void CloseSavegame() = 0;
 
        };
 
    }
}
#endif