task< T > 模板类 参考

异步任务 更多...

#include <generator.hpp>

类
struct	promise_type
	任务的promise类型 更多...
struct	awaiter
	任务等待器 更多...

Public 成员函数
	task (coroutine_handle< promise_type > h)
	从协程句柄构造
	task (task &&other) noexcept
	移动构造函数
task &	operator= (task &&other) noexcept
	移动赋值运算符
	~task ()
	析构函数，销毁协程
awaiter	operator co_await ()
	获取等待器
bool	done () const noexcept
	检查任务是否已完成
void	resume ()
	恢复任务执行
T	get ()
	同步获取任务结果
void	set_cancellation_token (cancellation_token &token)
	设置取消令牌
bool	is_cancelled () const noexcept
	检查任务是否被取消

详细描述

template<typename T>
class task< T >

异步任务

模板参数

T

任务结果类型

表示一个可能产生结果的异步操作。 支持co_await等待、取消、组合等操作。

在文件 generator.hpp 第 466 行定义.

构造及析构函数说明

task() [1/2]

template<typename T>

task< T >::task ( coroutine_handle< promise_type > h )

inlineexplicit

从协程句柄构造

参数

h

协程句柄

在文件 generator.hpp 第 593 行定义.

被这些函数引用 task< T >::promise_type::get_return_object(), operator=() , 以及 task().

task() [2/2]

template<typename T>

task< T >::task ( task< T > && other )

inlinenoexcept

移动构造函数

参数

other

被移动的对象

在文件 generator.hpp 第 600 行定义.

引用了 task().

成员函数说明

done()

template<typename T>

bool task< T >::done ( ) const

inlinenoexcept

检查任务是否已完成

返回

是否已完成

在文件 generator.hpp 第 646 行定义.

get()

template<typename T>

T task< T >::get ( )

inline

同步获取任务结果

返回

任务结果

在文件 generator.hpp 第 661 行定义.

引用了 move() , 以及 rethrow_exception().

is_cancelled()

template<typename T>

bool task< T >::is_cancelled ( ) const

inlinenoexcept

检查任务是否被取消

返回

是否被取消

在文件 generator.hpp 第 685 行定义.

operator co_await()

template<typename T>

awaiter task< T >::operator co_await ( )

inline

获取等待器

返回

等待器对象

在文件 generator.hpp 第 640 行定义.

operator=()

template<typename T>

task & task< T >::operator= ( task< T > && other )

inlinenoexcept

移动赋值运算符

参数

other

被移动的对象

返回

自身引用

在文件 generator.hpp 第 610 行定义.

引用了 addressof() , 以及 task().

set_cancellation_token()

template<typename T>

void task< T >::set_cancellation_token ( cancellation_token & token )

inline

设置取消令牌

参数

token

取消令牌

在文件 generator.hpp 第 675 行定义.

---

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

• generator.hpp