1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
|
// --------------------------------------------------------------------------
//
// File
// Name: BackupDaemonInterface.h
// Purpose: Interfaces for managing a BackupDaemon
// Created: 2008/12/30
//
// --------------------------------------------------------------------------
#ifndef BACKUPDAEMONINTERFACE__H
#define BACKUPDAEMONINTERFACE__H
#include <string>
#include "BoxTime.h"
class Archive;
class BackupClientContext;
class BackupDaemon;
// --------------------------------------------------------------------------
//
// Class
// Name: SysadminNotifier
// Purpose: Provides a NotifySysadmin() method to send mail to the sysadmin
// Created: 2005/11/15
//
// --------------------------------------------------------------------------
class SysadminNotifier
{
public:
virtual ~SysadminNotifier() { }
typedef enum
{
StoreFull = 0,
ReadError,
BackupError,
BackupStart,
BackupFinish,
BackupOK,
MAX
// When adding notifications, remember to add
// strings to NotifySysadmin()
}
EventCode;
virtual void NotifySysadmin(EventCode Event) = 0;
};
// --------------------------------------------------------------------------
//
// Class
// Name: ProgressNotifier
// Purpose: Provides methods for the backup library to inform the user
// interface about its progress with the backup
// Created: 2005/11/20
//
// --------------------------------------------------------------------------
class BackupClientContext;
class BackupClientDirectoryRecord;
class ProgressNotifier
{
public:
virtual ~ProgressNotifier() { }
virtual void NotifyIDMapsSetup(BackupClientContext& rContext) = 0;
virtual void NotifyScanDirectory(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyDirStatFailed(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const std::string& rErrorMsg) = 0;
virtual void NotifyFileStatFailed(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const std::string& rErrorMsg) = 0;
virtual void NotifyDirListFailed(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const std::string& rErrorMsg) = 0;
virtual void NotifyMountPointSkipped(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileExcluded(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyDirExcluded(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyUnsupportedFileType(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileReadFailed(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const std::string& rErrorMsg) = 0;
virtual void NotifyFileModifiedInFuture(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileSkippedServerFull(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileUploadException(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const BoxException& rException) = 0;
virtual void NotifyFileUploadServerError(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
int type, int subtype) = 0;
virtual void NotifyFileUploading(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileUploadingPatch(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
int64_t EstimatedBytesToUpload) = 0;
virtual void NotifyFileUploadingAttributes(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileUploaded(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
int64_t FileSize, int64_t UploadedSize, int64_t ObjectID) = 0;
virtual void NotifyFileSynchronised(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
int64_t FileSize) = 0;
virtual void NotifyDirectoryCreated(
int64_t ObjectID,
const std::string& rLocalPath,
const std::string& rRemotePath) = 0;
virtual void NotifyDirectoryDeleted(
int64_t ObjectID,
const std::string& rRemotePath) = 0;
virtual void NotifyFileDeleted(
int64_t ObjectID,
const std::string& rRemotePath) = 0;
virtual void NotifyReadProgress(int64_t readSize, int64_t offset,
int64_t length, box_time_t elapsed, box_time_t finish) = 0;
virtual void NotifyReadProgress(int64_t readSize, int64_t offset,
int64_t length) = 0;
virtual void NotifyReadProgress(int64_t readSize, int64_t offset) = 0;
};
// --------------------------------------------------------------------------
//
// Class
// Name: LocationResolver
// Purpose: Interface for classes that can resolve locations to paths,
// like BackupDaemon
// Created: 2003/10/08
//
// --------------------------------------------------------------------------
class LocationResolver
{
public:
virtual ~LocationResolver() { }
virtual bool FindLocationPathName(const std::string &rLocationName,
std::string &rPathOut) const = 0;
};
#endif // BACKUPDAEMONINTERFACE__H
|