Skip to content

Commit a5e7840

Browse files
sbusch42sbusch42
authored
Merge pull request #20 from cginternals/watcher
File system watcher
2 parents d6cae09 + e2f78b6 commit a5e7840

32 files changed

+1721
-14
lines changed

‎AUTHORS

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11

22
Stefan Buschmann <[email protected]> <[email protected]>
3-
Daniel Limberger <[email protected]> <[email protected]>
3+
Daniel Limberger <[email protected]> <[email protected]>
44
Willy Scheibel <[email protected]> <[email protected]>
55

6-
Thanks to all Contributors
6+
7+
Thanks to all Contributors:
8+
9+
Robert Bielik (https://github.com/robiwano)

‎source/cppfs/CMakeLists.txt

+29-1
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,13 @@ set(headers
5656
${include_path}/FileIterator.h
5757
${include_path}/FileVisitor.h
5858
${include_path}/FunctionalFileVisitor.h
59+
${include_path}/FileWatcher.h
60+
${include_path}/FileEventHandler.h
61+
${include_path}/FunctionalFileEventHandler.h
5962
${include_path}/AbstractFileSystem.h
6063
${include_path}/AbstractFileHandleBackend.h
6164
${include_path}/AbstractFileIteratorBackend.h
65+
${include_path}/AbstractFileWatcherBackend.h
6266
${include_path}/InputStream.h
6367
${include_path}/OutputStream.h
6468
${include_path}/LoginCredentials.h
@@ -81,9 +85,13 @@ set(sources
8185
${source_path}/FileIterator.cpp
8286
${source_path}/FileVisitor.cpp
8387
${source_path}/FunctionalFileVisitor.cpp
88+
${source_path}/FileWatcher.cpp
89+
${source_path}/FileEventHandler.cpp
90+
${source_path}/FunctionalFileEventHandler.cpp
8491
${source_path}/AbstractFileSystem.cpp
8592
${source_path}/AbstractFileHandleBackend.cpp
8693
${source_path}/AbstractFileIteratorBackend.cpp
94+
${source_path}/AbstractFileWatcherBackend.cpp
8795
${source_path}/InputStream.cpp
8896
${source_path}/OutputStream.cpp
8997
${source_path}/LoginCredentials.cpp
@@ -98,6 +106,26 @@ set(sources
98106
${source_path}/${localfs}/LocalFileIterator.cpp
99107
)
100108

109+
if("${CMAKE_SYSTEM_NAME}" MATCHES "Linux")
110+
set(headers ${headers}
111+
${include_path}/linux/LocalFileWatcher.h
112+
)
113+
114+
set(sources ${sources}
115+
${source_path}/linux/LocalFileWatcher.cpp
116+
)
117+
endif()
118+
119+
if("${CMAKE_SYSTEM_NAME}" MATCHES "Windows")
120+
set(headers ${headers}
121+
${include_path}/windows/LocalFileWatcher.h
122+
)
123+
124+
set(sources ${sources}
125+
${source_path}/windows/LocalFileWatcher.cpp
126+
)
127+
endif()
128+
101129
if (OPTION_BUILD_SSH_BACKEND)
102130
set(headers ${headers}
103131
${include_path}/ssh/SshFileSystem.h
@@ -114,7 +142,7 @@ if (OPTION_BUILD_SSH_BACKEND)
114142
${source_path}/ssh/SshInputStreamBuffer.cpp
115143
${source_path}/ssh/SshOutputStreamBuffer.cpp
116144
)
117-
endif ()
145+
endif()
118146

119147
# Group source files
120148
set(header_group "Header Files (API)")

‎source/cppfs/include/cppfs/AbstractFileSystem.h

+15
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
#pragma once
33

44

5+
#include <memory>
56
#include <string>
67

78
#include <cppfs/cppfs_api.h>
@@ -12,6 +13,8 @@ namespace cppfs
1213

1314

1415
class FileHandle;
16+
class FileWatcher;
17+
class AbstractFileWatcherBackend;
1518

1619

1720
/**
@@ -50,6 +53,18 @@ class CPPFS_API AbstractFileSystem
5053
* Path to file or directory
5154
*/
5255
virtual FileHandle open(std::string && path) = 0;
56+
57+
/**
58+
* @brief
59+
* Create a watcher for the file system
60+
*
61+
* @param[in] fileWatcher
62+
* File watcher that owns the backend
63+
*
64+
* @return
65+
* Watcher backend (must NOT be null!)
66+
*/
67+
virtual std::unique_ptr<AbstractFileWatcherBackend> createFileWatcher(FileWatcher & fileWatcher) = 0;
5368
};
5469

5570

‎source/cppfs/include/cppfs/AbstractFileWatcherBackend.h

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
2+
#pragma once
3+
4+
5+
#include <memory>
6+
7+
#include <cppfs/cppfs.h>
8+
9+
10+
namespace cppfs
11+
{
12+
13+
14+
class FileHandle;
15+
class FileWatcher;
16+
class AbstractFileSystem;
17+
18+
19+
/**
20+
* @brief
21+
* Interface for file watchers
22+
*/
23+
class CPPFS_API AbstractFileWatcherBackend
24+
{
25+
friend class FileWatcher;
26+
27+
28+
public:
29+
/**
30+
* @brief
31+
* Constructor
32+
*
33+
* @param[in] fileWatcher
34+
* File watcher that owns the backend (must NOT be null!)
35+
*/
36+
AbstractFileWatcherBackend(FileWatcher * fileWatcher);
37+
38+
/**
39+
* @brief
40+
* Destructor
41+
*/
42+
virtual ~AbstractFileWatcherBackend();
43+
44+
/**
45+
* @brief
46+
* Get file system
47+
*
48+
* @return
49+
* File system (must NOT be null)
50+
*/
51+
virtual AbstractFileSystem * fs() const = 0;
52+
53+
/**
54+
* @brief
55+
* Watch directory
56+
*
57+
* @param[in] dir
58+
* Handle to directory that shall be watched
59+
* @param[in] events
60+
* Events that are watched (combination of FileEvent values)
61+
* @param[in] recursive
62+
* Watch file system recursively?
63+
*/
64+
virtual void add(FileHandle & dir, unsigned int events, RecursiveMode recursive) = 0;
65+
66+
/**
67+
* @brief
68+
* Start watching files
69+
*
70+
* @param[in] timeout
71+
* Timeout value in milliseconds. If less than zero, timeout is infinite and the function blocks.
72+
*
73+
* @remarks
74+
* This function shall watch the file system and block until one or more
75+
* events have occured, or if the timeout has been exceeded (timeout >= 0).
76+
* For each event, onFileEvent has to be called with the type of the event and
77+
* a file handle to the file or directory. After all events have been
78+
* processed, the function shall return.
79+
*/
80+
virtual void watch(int timeout) = 0;
81+
82+
83+
protected:
84+
/**
85+
* @brief
86+
* Called on each file event
87+
*
88+
* @param[in] fh
89+
* File handle
90+
* @param[in] event
91+
* Type of event that has occured
92+
*/
93+
void onFileEvent(FileHandle & fh, FileEvent event);
94+
95+
96+
protected:
97+
FileWatcher * m_fileWatcher; ///< File watcher that owns the backend (never null)
98+
};
99+
100+
101+
} // namespace cppfs

‎source/cppfs/include/cppfs/FileEventHandler.h

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
2+
#pragma once
3+
4+
5+
#include <cppfs/cppfs.h>
6+
7+
8+
namespace cppfs
9+
{
10+
11+
12+
class FileHandle;
13+
14+
15+
/**
16+
* @brief
17+
* Handler that is informed about file system events
18+
*
19+
* @remarks
20+
* Use FileWatcher to register file event handlers.
21+
*/
22+
class CPPFS_API FileEventHandler
23+
{
24+
friend class FileWatcher;
25+
26+
27+
public:
28+
/**
29+
* @brief
30+
* Constructor
31+
*/
32+
FileEventHandler();
33+
34+
/**
35+
* @brief
36+
* Destructor
37+
*/
38+
virtual ~FileEventHandler();
39+
40+
41+
protected:
42+
/**
43+
* @brief
44+
* Called on file event
45+
*
46+
* @param[in] fh
47+
* Handle to file or directory
48+
* @param[in] event
49+
* Type of event that has occured
50+
*/
51+
virtual void onFileEvent(FileHandle & fh, FileEvent event);
52+
53+
/**
54+
* @brief
55+
* Called when a file or directory has been created
56+
*
57+
* @param[in] fh
58+
* Handle to file or directory
59+
*/
60+
virtual void onFileCreated(FileHandle & fh);
61+
62+
/**
63+
* @brief
64+
* Called when a file or directory has been removed
65+
*
66+
* @param[in] fh
67+
* Handle to file or directory
68+
*/
69+
virtual void onFileRemoved(FileHandle & fh);
70+
71+
/**
72+
* @brief
73+
* Called when a file or directory has been modified
74+
*
75+
* @param[in] fh
76+
* Handle to file or directory
77+
*/
78+
virtual void onFileModified(FileHandle & fh);
79+
80+
/**
81+
* @brief
82+
* Called when file attributes have been modified
83+
*
84+
* @param[in] fh
85+
* Handle to file or directory
86+
*/
87+
virtual void onFileAttrChanged(FileHandle & fh);
88+
};
89+
90+
91+
} // namespace cppfs

‎source/cppfs/include/cppfs/FileHandle.h

+32-1
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,19 @@
88
#include <vector>
99
#include <string>
1010

11-
#include <cppfs/cppfs_api.h>
11+
#include <cppfs/cppfs.h>
1212
#include <cppfs/AbstractFileHandleBackend.h>
1313

1414

1515
namespace cppfs
1616
{
1717

1818

19+
class AbstractFileSystem;
1920
class FileIterator;
2021
class FileVisitor;
2122
class Tree;
23+
class FileWatcher;
2224

2325

2426
/**
@@ -104,6 +106,15 @@ class CPPFS_API FileHandle
104106
*/
105107
FileHandle & operator=(FileHandle && fileHandle);
106108

109+
/**
110+
* @brief
111+
* Get file system
112+
*
113+
* @return
114+
* File system (can be null)
115+
*/
116+
AbstractFileSystem * fs() const;
117+
107118
/**
108119
* @brief
109120
* Get path
@@ -478,6 +489,26 @@ class CPPFS_API FileHandle
478489
*/
479490
bool remove();
480491

492+
/**
493+
* @brief
494+
* Create file system watcher for this file handle
495+
*
496+
* @param[in] events
497+
* Events that are watched (combination of FileEvent values)
498+
* @param[in] recursive
499+
* Watch file system recursively?
500+
*
501+
* @return
502+
* File watcher
503+
*
504+
* @remarks
505+
* This is a shortcut for creating a FileWatcher and adding file handles to watch.
506+
* It will only work if the file handle points to a valid directory.
507+
* To watch more than one directory at a time, use FileWatcher and add.
508+
* Avoid creating more than one FileWatcher, as OS limits can be reached.
509+
*/
510+
FileWatcher watch(unsigned int events = FileCreated | FileRemoved | FileModified | FileAttrChanged, RecursiveMode recursive = Recursive);
511+
481512
/**
482513
* @brief
483514
* Create input stream to read from the file

0 commit comments

Comments
 (0)