Debian Codegraph @

docs/util/dthreadutils.zh_CN.dox

raw
1 /*!
2 @~chinese
3 @ingroup dutil
4 @file include/util/dthreadutils.h
5
6 本文件定义了线程相关的帮助类
7
8 @class DThreadUtils
9 @brief 线程帮助类
10 @details 本类主要用来进行异步线程调用, 此外本类所有的public接口都是线程安全的
11
12 @fn static DThreadUtils& DThreadUtils::gui()
13 @brief 获取以GUI线程初始化的静态对象
14 @return DThreadUtils& 静态对象的引用
15
16 @fn QThread* DThreadUtils::thread() const noexcept
17 @brief 获取DThreadUtils对应的线程
18 @return QThread* 对应线程的QThread对象的指针
19
20 @fn template <typename Func, typename... Args> inline auto run(QObject *context,typename QtPrivate::FunctionPointer<Func>::Object *obj, Func fun, Args &&...args)
21 @brief 在对应的线程执行传入的成员函数, 非阻塞
22 @param[in] context 对象上下文, 用来在执行调用时判断对象是否存在
23 @param[in] obj 对象指针
24 @param[in] fun 成员函数指针
25 @param[in] args 对应函数的参数
26 @return 以成员函数返回值类型实例化的QFuture对象
27
28 @fn template <typename Func, typename... Args> inline auto run(typename QtPrivate::FunctionPointer<Func>::Object *obj, Func fun, Args &&...args)
29 @brief 在对应的线程执行传入的成员函数, 非阻塞
30 @param[in] obj 对象指针
31 @param[in] fun 成员函数指针
32 @param[in] args 对应函数的参数
33 @return 以成员函数返回值类型实例化的QFuture对象
34
35 @fn template <typename Func, typename... Args> inline QFuture<std::invoke_result_t<std::decay_t<Func>, Args...>> run(QObject *context, Func fun, Args &&...args)
36 @brief 在对应的线程执行传入的成员函数, 非阻塞
37 @param[in] context 对象上下文, 用来在执行调用时判断对象是否存在
38 @param[in] fun 成员函数指针
39 @param[in] args 对应函数的参数
40 @return 以成员函数返回值类型实例化的QFuture对象
41
42 @fn template <typename Func, typename... Args> inline QFuture<std::invoke_result_t<std::decay_t<Func>, Args...>> run(Func fun, Args &&...args)
43 @brief 在对应的线程执行传入的成员函数, 非阻塞
44 @param[in] fun 可调用对象
45 @param[in] args 调用对应的参数
46 @return 以函数返回值类型实例化的QFuture对象
47
48 @fn template <typename... T> inline decltype(auto) exec(T &&...args)
49 @brief 在对应的线程执行传入的成员函数, 阻塞
50 @details 本函数是run函数的包装
51 @note 调用此函数的一方需要确保对应线程有事件循环, 否则会无限等待
52 @param[in] args 参数包, 具体含义参考run函数
53 @return 传入函数的返回值
54
55 */