IStorage.h

Go to the documentation of this file.

#ifndef GALAXY_I_STORAGE_H
#define GALAXY_I_STORAGE_H
 
#include "GalaxyID.h"
#include "IListenerRegistrar.h"
 
namespace galaxy
{
    namespace api
    {
        typedef uint64_t SharedFileID;
 
        class IFileShareListener : public GalaxyTypeAwareListener<FILE_SHARE>
        {
        public:
 
            virtual void OnFileShareSuccess(const char* fileName, SharedFileID sharedFileID) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnFileShareFailure(const char* fileName, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IFileShareListener> GlobalFileShareListener;
 
        class ISharedFileDownloadListener : public GalaxyTypeAwareListener<SHARED_FILE_DOWNLOAD>
        {
        public:
 
            virtual void OnSharedFileDownloadSuccess(SharedFileID sharedFileID, const char* fileName) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnSharedFileDownloadFailure(SharedFileID sharedFileID, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<ISharedFileDownloadListener> GlobalSharedFileDownloadListener;
 
        class IStorage
        {
        public:
 
            virtual ~IStorage()
            {
            }
 
            virtual void FileWrite(const char* fileName, const void* data, uint32_t dataSize) = 0;
 
            virtual uint32_t FileRead(const char* fileName, void* data, uint32_t dataSize) = 0;
 
            virtual void FileDelete(const char* fileName) = 0;
 
            virtual bool FileExists(const char* fileName) = 0;
 
            virtual uint32_t GetFileSize(const char* fileName) = 0;
 
            virtual uint32_t GetFileTimestamp(const char* fileName) = 0;
 
            virtual uint32_t GetFileCount() = 0;
 
            virtual const char* GetFileNameByIndex(uint32_t index) = 0;
 
            virtual void GetFileNameCopyByIndex(uint32_t index, char* buffer, uint32_t bufferLength) = 0;
 
            virtual void FileShare(const char* fileName, IFileShareListener* const listener = NULL) = 0;
 
            virtual void DownloadSharedFile(SharedFileID sharedFileID, ISharedFileDownloadListener* const listener = NULL) = 0;
 
            virtual const char* GetSharedFileName(SharedFileID sharedFileID) = 0;
 
            virtual void GetSharedFileNameCopy(SharedFileID sharedFileID, char* buffer, uint32_t bufferLength) = 0;
 
            virtual uint32_t GetSharedFileSize(SharedFileID sharedFileID) = 0;
 
            virtual GalaxyID GetSharedFileOwner(SharedFileID sharedFileID) = 0;
 
            virtual uint32_t SharedFileRead(SharedFileID sharedFileID, void* data, uint32_t dataSize, uint32_t offset = 0) = 0;
 
            virtual void SharedFileClose(SharedFileID sharedFileID) = 0;
 
            virtual uint32_t GetDownloadedSharedFileCount() = 0;
 
            virtual SharedFileID GetDownloadedSharedFileByIndex(uint32_t index) = 0;
        };
 
    }
}
 
#endif