https://github.com/erikzenker/inotify-cpp
A C++ interface for linux inotify
https://github.com/erikzenker/inotify-cpp
c-plus-plus linux-inotify wrapper
Last synced: 10 days ago
JSON representation
A C++ interface for linux inotify
- Host: GitHub
- URL: https://github.com/erikzenker/inotify-cpp
- Owner: erikzenker
- License: mit
- Created: 2013-09-18T19:17:09.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2023-09-04T05:35:28.000Z (about 2 years ago)
- Last Synced: 2025-04-07T07:42:51.458Z (7 months ago)
- Topics: c-plus-plus, linux-inotify, wrapper
- Language: C++
- Homepage:
- Size: 166 KB
- Stars: 137
- Watchers: 5
- Forks: 38
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Inotify-cpp #
 [](https://codecov.io/gh/erikzenker/inotify-cpp) [](https://paypal.me/erikzenker)
===========
__Inotify-cpp__ is a C++ wrapper for linux inotify. It lets you watch for
filesystem events on your filesystem tree. The following usage example shows
the implementation of a simple filesystem event watcher for the commandline.
## Usage ##
```c++
#include
#include
#include
#include
#include
using namespace inotify;
int main(int argc, char** argv)
{
if (argc <= 1) {
std::cout << "Usage: ./inotify_example /path/to/dir" << std::endl;
exit(0);
}
// Parse the directory to watch
std::filesystem::path path(argv[1]);
// Set the event handler which will be used to process particular events
auto handleNotification = [&](Notification notification) {
std::cout << "Event " << notification.event << " on " << notification.path << " at "
<< notification.time.time_since_epoch().count() << " was triggered." << std::endl;
};
// Set the a separate unexpected event handler for all other events. An exception is thrown by
// default.
auto handleUnexpectedNotification = [](Notification notification) {
std::cout << "Event " << notification.event << " on " << notification.path << " at "
<< notification.time.time_since_epoch().count()
<< " was triggered, but was not expected" << std::endl;
};
// Set the events to be notified for
auto events = { Event::open | Event::is_dir, // some events occur in combinations
Event::access,
Event::create,
Event::modify,
Event::remove,
Event::move };
// The notifier is configured to watch the parsed path for the defined events. Particular files
// or paths can be ignored(once).
auto notifier = BuildNotifier()
.watchPathRecursively(path)
.ignoreFileOnce("fileIgnoredOnce")
.ignoreFile("fileIgnored")
.onEvents(events, handleNotification)
.onUnexpectedEvent(handleUnexpectedNotification);
// The event loop is started in a separate thread context.
std::thread thread([&](){ notifier.run(); });
// Terminate the event loop after 60 seconds
std::this_thread::sleep_for(std::chrono::seconds(60));
notifier.stop();
thread.join();
return 0;
}
```
## Build and Install Library ##
```bash
mkdir build; cd build
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
cmake --build .
# run tests
ctest -VV
# install the library
cmake --build . --target install
```
## Build Example ##
```bash
mkdir build; cd build
cmake ..
cmake --build . --target inotify_example
./example/inotify_example
```
## Install from Packet ##
* Arch Linux: `yaourt -S inotify-cpp-git`
## Dependencies ##
+ lib
+ boost 1.54.0
+ c++17
+ linux 2.6.13
+ build
+ cmake 3.8
## Licence
MIT
## Author ##
Written by Erik Zenker (erikzenker@hotmail.com)
## Thanks for Contribution ##
+ [spelcaster](https://github.com/spelcaster)