summaryrefslogtreecommitdiff
path: root/lib/backupstore/BackgroundTask.h
blob: bae9162f90ff49040c3170e9fb0b1c072d029bc9 (plain)
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
// --------------------------------------------------------------------------
//
// File
//		Name:    BackgroundTask.h
//		Purpose: Declares the BackgroundTask interface.
//		Created: 2014/04/07
//
// --------------------------------------------------------------------------

#ifndef BACKGROUNDTASK__H
#define BACKGROUNDTASK__H

// --------------------------------------------------------------------------
//
// Class
//		Name:    BackgroundTask
//		Purpose: Provides a RunBackgroundTask() method which allows
//			 background tasks such as polling the command socket
//			 to happen while a file is being uploaded. If it
//			 returns false, the current task should be aborted.
//		Created: 2014/04/07
//
// --------------------------------------------------------------------------
class BackgroundTask
{
	public:
	enum State {
		Unknown = 0,
		Scanning_Dirs,
		Searching_Blocks,
		Uploading_Full,
		Uploading_Patch,
	};
	virtual ~BackgroundTask() { }
	virtual bool RunBackgroundTask(State state, uint64_t progress,
		uint64_t maximum) = 0;
};

#endif // BACKGROUNDTASK__H