acl::aio_timer_callback类 参考

#include <aio_timer_callback.hpp>

类 acl::aio_timer_callback 继承关系图:

acl::aio_timer_callback 的协作图:

Public 成员函数
	aio_timer_callback (bool keep=false)
virtual	~aio_timer_callback (void)
virtual void	destroy (void)
bool	empty (void) const
size_t	length (void) const
void	keep_timer (bool on)
bool	keep_timer (void) const
int	clear (void)
Public 成员函数 继承自 acl::aio_delay_free
	aio_delay_free (void)
virtual	~aio_delay_free (void)
bool	locked (void) const
void	set_locked (void)
void	unset_locked (void)

Protected 成员函数
virtual void	timer_callback (unsigned int id)=0
long long int	set_task (unsigned int id, long long int delay)
long long int	del_task (unsigned int id)
void	set_time (void)
Protected 成员函数 继承自 acl::acl::noncopyable
	noncopyable ()
	~noncopyable ()

Protected 属性
long long int	present_

友元
class	aio_handle

详细描述

定时器的回调类

在文件 aio_timer_callback.hpp 第 15 行定义.

构造及析构函数说明

aio_timer_callback()

acl::aio_timer_callback::aio_timer_callback

(

bool

keep = false

)

构造函数

参数

keep	{bool} 该定时器是否允许自动重启

~aio_timer_callback()

virtual acl::aio_timer_callback::~aio_timer_callback ( void  )

virtual

成员函数说明

clear()

int acl::aio_timer_callback::clear

(

void

)

清空定时器里的定时任务

返回

{int} 被清除的定时任务的个数

del_task()

long long int acl::aio_timer_callback::del_task ( unsigned int  id )

protected

destroy()

virtual void acl::aio_timer_callback::destroy ( void  )

inlinevirtual

当定时器里的任务数为空时的回调函数， 子类可以在其中释放，一旦该函数被调用， 则意味着该定时器及其中的所有定时任务都从 定时器集合中被删除 该函数被触发的条件有三个： 1) 定时器所有的任务数为 0 时(如， del_timer(aio_timer_callback*, unsigned int) 被 调用且任务数为 0 时) 2) 当 aio_handle 没有设置重复定时器且该定时器中 有一个定时任务被触发后 3) 当 del_timer(aio_timer_callback*) 被调用后

重载 acl::aio_delay_free .

被 acl::aio_timer_writer , 以及 acl::aio_timer_reader 重载.

在文件 aio_timer_callback.hpp 第 38 行定义.

{}

empty()

bool acl::aio_timer_callback::empty

(

void

)

const

定时器里的任务是否为空

返回

{bool}

keep_timer() [1/2]

void acl::aio_timer_callback::keep_timer

(

bool

on

)

该定时器是否是自动重启的

参数

on

{bool}

keep_timer() [2/2]

bool acl::aio_timer_callback::keep_timer

(

void

)

const

判断该定时器是否是自动重启的

返回

{bool}

length()

size_t acl::aio_timer_callback::length

(

void

)

const

定时器里的任务个数

返回

{size_t}

set_task()

long long int acl::aio_timer_callback::set_task ( unsigned int  id, long long int  delay  )

protected

set_time()

void acl::aio_timer_callback::set_time ( void  )

protected

设置当前定时器的时间截

timer_callback()

virtual void acl::aio_timer_callback::timer_callback ( unsigned int  id )

protectedpure virtual

子类必须实现此回调函数，注：子类或调用者禁止在 timer_callback 内部调用 aio_timer_callback 的析构 函数，否则将会酿成大祸

参数

id	{unsigned int} 对应某个任务的 ID 号

在 acl::aio_timer_writer , 以及 acl::aio_timer_reader 内被实现.

友元及相关函数文档

aio_handle

friend class aio_handle

friend

在文件 aio_timer_callback.hpp 第 71 行定义.

类成员变量说明

present_

long long int acl::aio_timer_callback::present_

protected

在文件 aio_timer_callback.hpp 第 104 行定义.

---

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

• include/acl_cpp/stream/aio_timer_callback.hpp