项目作者: p-ranav

项目描述 :
File/Directory Watcher for Modern C++
高级语言: C++
项目地址: git://github.com/p-ranav/fswatch.git
创建时间: 2019-08-18T00:43:21Z
项目社区:https://github.com/p-ranav/fswatch

开源协议:MIT License

下载



fswatch

Highlights

  • Single header file
  • Requires C++17 and std::filesystem
  • MIT License
  • For now, ONLY works in Linux - based on inotify

Quick Start

Simply include fswatch.hpp and you’re good to go.

  1. #include <fswatch.hpp>

To start watching files, create an fswatch object and provide a variadic list of directories to watch.

The constructor takes variadic arguments - Simply provide a list of directories to watch. This watcher will observe your home directory, /opt, /tmp and the current working directory.

  1. auto watcher = fswatch("~", "/opt", "/tmp", ".");
  2. try {
  3. watcher.start();
  4. } catch (const std::runtime_error& error) {
  5. std::cout << error.what() << std::endl;
  6. }

Register callbacks to events

To add callbacks to events, use the watcher.on(...) method like so:

  1. watcher.on(fswatch::Event::FILE_CREATED, [](auto &event) {
  2. std::cout << "File created: " << event.path << std::endl;
  3. });

You can register a single callback for multiple events like this:

  1. watcher.on({ fswatch::Event::FILE_OPENED, fswatch::Event::FILE_CLOSED },
  2. [](auto &event) {
  3. if (event.type == fswatch::Event::FILE_OPENED)
  4. std::cout << "File opened: " << event.path << std::endl;
  5. else
  6. std::cout << "File closed: " << event.path << std::endl;
  7. });

Here are the list of events that fswatch can handle:

File Events

Event Description
FILE_CREATED File created in watched directory
FILE_OPENED File opened in watched directory
FILE_MODIFIED File modified in watched directory (e.g., write, truncate)
FILE_CLOSED File closed in watched directory
FILE_DELETED File deleted from watched directory

Directory Events

Event Description
DIR_CREATED Directory created in watched directory
DIR_OPENED Directory opened in watched directory (e.g., when running ls)
DIR_MODIFIED Directory modified in watched directory
DIR_CLOSED Directory closed in watched directory
DIR_DELETED Directory deleted from watched directory

Todo

  1. Suppport Win32, FreeBSD, and OSX