basic_timer< Clock > 模板类 参考

基本定时器 更多...

#include <timer.hpp>

Public 类型
using	clock_type = Clock
	时钟类型
using	time_point = typename clock_type::time_point
	时间点类型
using	duration = typename clock_type::duration
	时长类型
using	token = typename timer_scheduler<Clock>::token
	任务标识符类型
using	handler_type = typename timer_scheduler<Clock>::handler_type
	回调函数类型

Public 成员函数
	~basic_timer ()
	析构函数，自动取消未完成的任务
	basic_timer (basic_timer &&other) noexcept
	移动构造函数
basic_timer &	operator= (basic_timer &&other) noexcept
	移动赋值运算符
void	expires_at (const time_point &expiry_time)
	设置绝对到期时间
void	expires_after (const duration &expiry_duration)
	设置相对到期时间
void	expires_from_now (const int64_t ms)
	设置从当前时间开始的毫秒数
NEFORCE_NODISCARD time_point	expiry () const
	获取到期时间点
NEFORCE_NODISCARD bool	is_active () const
	检查定时器是否活跃（有待执行的任务）
template<typename WaitHandler>
void	async_wait (WaitHandler &&handler)
	异步等待定时器到期
void	cancel ()
	取消定时任务

详细描述

template<typename Clock>
class basic_timer< Clock >

基本定时器

模板参数

Clock

时钟类型

封装一个定时任务，提供简单的设置和等待接口。 支持一次性定时和取消操作。

在文件 timer.hpp 第 248 行定义.

成员函数说明

async_wait()

template<typename Clock>

template<typename WaitHandler>

void basic_timer< Clock >::async_wait ( WaitHandler && handler )

inline

异步等待定时器到期

模板参数

WaitHandler

回调函数类型

参数

handler

到期时执行的回调函数

如果之前有未完成的任务，会自动取消。 回调函数会在调度线程中执行，不应包含耗时操作。

在文件 timer.hpp 第 347 行定义.

cancel()

template<typename Clock>

void basic_timer< Clock >::cancel ( )

inline

取消定时任务

如果任务尚未执行，会从调度器中移除。

在文件 timer.hpp 第 357 行定义.

被这些函数引用 basic_timer< steady_clock >::async_wait(), basic_timer< steady_clock >::expires_after(), basic_timer< steady_clock >::expires_at(), basic_timer< steady_clock >::operator=() , 以及 basic_timer< steady_clock >::~basic_timer().

expires_after()

template<typename Clock>

void basic_timer< Clock >::expires_after ( const duration & expiry_duration )

inline

设置相对到期时间

参数

expiry_duration

从当前时间开始的时长

如果之前有未完成的任务，会自动取消。

在文件 timer.hpp 第 315 行定义.

被这些函数引用 basic_timer< steady_clock >::expires_from_now().

expires_at()

template<typename Clock>

void basic_timer< Clock >::expires_at ( const time_point & expiry_time )

inline

设置绝对到期时间

参数

expiry_time

到期时间点

如果之前有未完成的任务，会自动取消。

在文件 timer.hpp 第 304 行定义.

expires_from_now()

template<typename Clock>

void basic_timer< Clock >::expires_from_now ( const int64_t ms )

inline

设置从当前时间开始的毫秒数

参数

ms

毫秒数

在文件 timer.hpp 第 324 行定义.

expiry()

template<typename Clock>

NEFORCE_NODISCARD time_point basic_timer< Clock >::expiry ( ) const

inline

获取到期时间点

返回

到期时间点

在文件 timer.hpp 第 330 行定义.

is_active()

template<typename Clock>

NEFORCE_NODISCARD bool basic_timer< Clock >::is_active ( ) const

inline

检查定时器是否活跃（有待执行的任务）

返回

是否活跃

在文件 timer.hpp 第 336 行定义.

---

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

• timer.hpp