file_watcher类 参考

文件系统监视器 更多...

#include <file_watcher.hpp>

Public 成员函数
	file_watcher (path watch_path, bool recursive=false)
	构造函数
	~file_watcher ()
	析构函数
bool	start (callback_t callback, file_watch_event events=file_watch_event::ALL)
	开始监视
void	stop ()
	停止监视
NEFORCE_NODISCARD const path &	watch_path () const noexcept
	获取监视的目录路径
NEFORCE_NODISCARD file_watch_event	current_events () const noexcept
	获取当前监视的事件类型
NEFORCE_NODISCARD bool	is_watching () const noexcept
	检查是否正在监视
NEFORCE_NODISCARD bool	is_recursive () const noexcept
	检查是否递归监视子目录
bool	update_watch (file_watch_event events)
	更新监视的事件类型
bool	update_recursive (bool recursive)
	更新递归设置

详细描述

文件系统监视器

监视指定目录中的文件变化事件，支持递归监视子目录。 当文件被创建、删除、修改、重命名或访问时，触发回调函数。

在文件 file_watcher.hpp 第 33 行定义.

构造及析构函数说明

file_watcher()

file_watcher::file_watcher ( path watch_path, bool recursive = false )

explicit

构造函数

参数

watch_path	要监视的目录路径
recursive	是否递归监视子目录

异常

system_exception

路径不存在或不是目录时抛出

引用了 watch_path().

被这些函数引用 ~file_watcher().

~file_watcher()

file_watcher::~file_watcher

(

)

析构函数

停止监视并清理资源。

引用了 file_watcher().

成员函数说明

current_events()

NEFORCE_NODISCARD file_watch_event file_watcher::current_events ( ) const

inlinenoexcept

获取当前监视的事件类型

返回

事件类型

在文件 file_watcher.hpp 第 112 行定义.

is_recursive()

NEFORCE_NODISCARD bool file_watcher::is_recursive ( ) const

inlinenoexcept

检查是否递归监视子目录

返回

是否递归

在文件 file_watcher.hpp 第 124 行定义.

is_watching()

NEFORCE_NODISCARD bool file_watcher::is_watching ( ) const

inlinenoexcept

检查是否正在监视

返回

是否正在监视

在文件 file_watcher.hpp 第 118 行定义.

start()

bool file_watcher::start	(	callback_t	callback,
		file_watch_event	events = file_watch_event::ALL )

开始监视

参数

callback	事件回调函数
events	要监视的事件类型

返回

是否成功启动

启动一个后台线程开始监视文件系统事件。 当指定的事件发生时，回调函数会被调用，参数为文件路径和事件类型。

引用了 ALL.

stop()

void file_watcher::stop

(

)

停止监视

停止监视线程并清理相关资源。

update_recursive()

bool file_watcher::update_recursive

(

bool

recursive

)

更新递归设置

参数

recursive

新的递归设置

返回

是否成功更新

如果正在监视中，会重启监视器以应用新的递归设置。

update_watch()

bool file_watcher::update_watch

(

file_watch_event

events

)

更新监视的事件类型

参数

events

新的事件类型

返回

是否成功更新

如果正在监视中，会重启监视器以应用新的事件类型。

watch_path()

NEFORCE_NODISCARD const path & file_watcher::watch_path ( ) const

inlinenoexcept

获取监视的目录路径

返回

目录路径

在文件 file_watcher.hpp 第 106 行定义.

被这些函数引用 file_watcher().

---

该类的文档由以下文件生成:

• file_watcher.hpp