blob: 5d51d6986bede55376bc363be408e12608b2f89e (
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
|
#ifndef DIR_LOCK_H_INCLUDED
#define DIR_LOCK_H_INCLUDED
#include "../shared/zstring.h"
#include "../shared/file_error.h"
#include <memory>
struct DirLockCallback //while waiting for the lock
{
virtual ~DirLockCallback() {}
virtual void requestUiRefresh() = 0; //allowed to throw exceptions
virtual void reportInfo(const Zstring& text) = 0;
};
/*
RAII structure to place a directory lock against other FFS processes:
- recursive locking supported, even with alternate lockfile names, e.g. via symlinks, network mounts etc.
- ownership shared between all object instances refering to a specific lock location(= UUID)
- can be copied safely and efficiently! (ref-counting)
- detects and resolves abandoned locks (instantly if lock is associated with local pc, else after 30 seconds)
- temporary locks created during abandoned lock resolution keep "lockfilename"'s extension
- race-free (Windows, almost on Linux(NFS))
*/
class DirLock
{
public:
DirLock(const Zstring& lockfilename, DirLockCallback* callback = NULL); //throw (FileError), callback only used during construction
private:
class LockAdmin;
class SharedDirLock;
std::shared_ptr<SharedDirLock> sharedLock;
};
#endif // DIR_LOCK_H_INCLUDED
|
