3.9

1 files changed, 35 insertions, 0 deletions

diff --git a/library/dir_lock.h b/library/dir_lock.h
new file mode 100644
index 00000000..e3b6597c
--- /dev/null
+++ b/library/dir_lock.h
@@ -0,0 +1,35 @@
+#ifndef DIR_LOCK_H_INCLUDED
+#define DIR_LOCK_H_INCLUDED
+
+#include "../shared/zstring.h"
+#include "../shared/file_error.h"
+#include <boost/shared_ptr.hpp>
+
+
+struct DirLockCallback //while waiting for the lock
+{
+    virtual ~DirLockCallback() {}
+    virtual void requestUiRefresh() = 0;  //allowed to throw exceptions
+    virtual void updateStatusText(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
+        - race-free (Windows, almost on Linux)
+*/
+class DirLock
+{
+public:
+    DirLock(const Zstring& lockfilename, DirLockCallback* callback = NULL); //throw (FileError)
+
+private:
+    class LockAdmin;
+    class SharedDirLock;
+    boost::shared_ptr<SharedDirLock> sharedLock;
+};
+
+#endif // DIR_LOCK_H_INCLUDED