vlink::Schedule::RetStatus类 参考

RAII handle returned by exec_task() for a bool-returning callback task. 更多...

#include <schedule.h>

类 vlink::Schedule::RetStatus 继承关系图:

vlink::Schedule::RetStatus 的协作图:

Public 成员函数
Status &	on_else (Callback &&callback)
	Registers a callback fired when the task returns false.
RetStatus &	on_then (RetCallback &&callback)
	Registers a callback chain element fired when the task returns true.
	Status ()
	Constructs an invalid Status (not yet associated with a task).
	Status (const Status &)=delete
	Status (Status &&status) noexcept
	Move constructor.
Public 成员函数 继承自 vlink::Schedule::Status
	Status ()
	Constructs an invalid Status (not yet associated with a task).
	~Status ()
	Destructor.
	Status (const Status &)=delete
Status &	operator= (const Status &)=delete
	Status (Status &&status) noexcept
	Move constructor.
Status &	operator= (Status &&status) noexcept
	Move assignment.
void	set_valid (bool valid)
	Sets whether the status is valid (task was successfully posted).
bool	is_valid () const
	Returns true if the associated task was posted successfully.
Status &	on_schedule_timeout (Callback &&callback)
	Registers a callback fired when the task does not start within schedule_timeout_ms.
Status &	on_execution_timeout (Callback &&callback)
	Registers a callback fired when the task runs longer than execution_timeout_ms.
Status &	on_catch (CatchCallback &&callback)
	Registers a callback fired when the task throws an exception.

额外继承的成员函数
Protected 属性 继承自 vlink::Schedule::Status
friend	Schedule
std::shared_ptr< StatusImpl >	impl_

详细描述

RAII handle returned by exec_task() for a bool-returning callback task.

Extends Status with on_then (fired if callback returns true) and on_else (fired if callback returns false).

成员函数说明

on_else()

Status & vlink::Schedule::RetStatus::on_else

(

Callback &&

callback

)

Registers a callback fired when the task returns false.

参数

callback

Invoked from the loop thread when the return value is false.

返回

Reference to the base Status for further chaining.

函数调用图:

on_then()

RetStatus & vlink::Schedule::RetStatus::on_then

(

RetCallback &&

callback

)

Registers a callback chain element fired when the task returns true.

Multiple on_then callbacks may be chained; each receives a bool return value from the previous callback in the chain.

参数

callback

Callback taking no arguments and returning bool.

返回

Reference to *this for further on_then chaining.

Status() [1/3]

vlink::Schedule::Status::Status

(

)

Constructs an invalid Status (not yet associated with a task).

这是这个函数的调用关系图:

Status() [2/3]

vlink::Schedule::Status::Status ( const Status & )

delete

Status() [3/3]

vlink::Schedule::Status::Status ( Status && status )

noexcept

Move constructor.

参数

status

Source status to move from.

---

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

• include/vlink/base/schedule.h