roboctrl::async 命名空间参考

异步上下文相关功能 更多...

详细描述

异步上下文相关功能

电控代码目前被实现为 单线程异步 ，即整个逻辑异步运行在单线程中。它避免了多线程同时访问内存， 但协程仍会在 co_await 处交错，因此共享状态、对象生命周期和异步写操作仍需显式管理。

异步上下文被设计成一个单例类，可以通过 roboctrl::get<task_context>() 获取，这是因为目前应该不需要多个异步任务上下文。

类
class	task_context
	异步任务上下文类。 更多...

类型定义
template<typename T = void>
using	awaitable = asio::awaitable< T >
	协程任务类型。
using	duration = std::chrono::steady_clock::duration

函数
auto	spawn (task_context::task_type &&task)
	添加一个协程任务到全局任务上下文中执行。
template<typename ... Args>
auto	post (Args &&... args)
	添加一个任务到全局任务上下文中执行。
void	run ()
	运行全局任务上下文。
bool	failed ()
	查询全局任务上下文是否因未处理异常进入过安全停机。
bool	shutdown_requested ()
	查询全局任务上下文是否已经进入停机流程。
void	set_shutdown_handler (task_context::shutdown_handler_type handler)
	设置全局任务上下文的一次性安全停机任务。
void	request_shutdown ()
	请求运行全局任务上下文的安全停机任务。
awaitable< void >	yield ()
	协程任务等待。用于让出当前函数的执行权。
awaitable< void >	wait_for (const duration &duration)
	协程任务等待。
auto	executor ()
	获取全局任务上下文的executor。
auto &	io_context ()
	获取全局任务上下文的io_context。
void	stop ()

类型定义说明

awaitable

template<typename T = void>

using roboctrl::async::awaitable = typedef asio::awaitable<T>

协程任务类型。

模板参数

T

返回值类型

在文件 async.hpp 第 46 行定义.

duration

using roboctrl::async::duration = typedef std::chrono::steady_clock::duration

在文件 async.hpp 第 48 行定义.

函数说明

executor()

auto roboctrl::async::executor ( )

inline

获取全局任务上下文的executor。

在文件 async.hpp 第 271 行定义.

被这些函数引用 roboctrl::io::tcp::tcp() , 以及 roboctrl::io::udp::udp().

failed()

bool roboctrl::async::failed ( )

inline

查询全局任务上下文是否因未处理异常进入过安全停机。

在文件 async.hpp 第 221 行定义.

io_context()

auto & roboctrl::async::io_context ( )

inline

获取全局任务上下文的io_context。

在文件 async.hpp 第 278 行定义.

被这些函数引用 roboctrl::io::can::can().

post()

template<typename ... Args>

auto roboctrl::async::post ( Args &&...  args )

inline

添加一个任务到全局任务上下文中执行。

模板参数

Args

任务参数类型

参数

args

任务参数

示例：

roboctrl::post([](int a,int b){std::print("{} + {} = {}\n",a,b,a+b);},1,2);

在文件 async.hpp 第 207 行定义.

request_shutdown()

void roboctrl::async::request_shutdown ( )

inline

请求运行全局任务上下文的安全停机任务。

在文件 async.hpp 第 236 行定义.

run()

void roboctrl::async::run ( )

inline

运行全局任务上下文。

在文件 async.hpp 第 216 行定义.

set_shutdown_handler()

void roboctrl::async::set_shutdown_handler ( task_context::shutdown_handler_type  handler )

inline

设置全局任务上下文的一次性安全停机任务。

在文件 async.hpp 第 231 行定义.

shutdown_requested()

bool roboctrl::async::shutdown_requested ( )

inline

查询全局任务上下文是否已经进入停机流程。

在文件 async.hpp 第 226 行定义.

被这些函数引用 roboctrl::ctrl::shoot::set_enabled(), roboctrl::device::dji_motor::set_enabled(), roboctrl::device::j6006::set_enabled(), roboctrl::device::m9025::set_enabled(), roboctrl::device::gkd_sentry_gimbal::set_enabled() , 以及 roboctrl::ctrl::robot::set_state().

spawn()

auto roboctrl::async::spawn ( task_context::task_type &&  task )

inline

添加一个协程任务到全局任务上下文中执行。

参数

task

任务

示例：

roboctrl::spawn([]() -> roboctrl::awaitable<void>{})

在文件 async.hpp 第 191 行定义.

被这些函数引用 roboctrl::ctrl::robot::init(), roboctrl::callback< Args >::operator()(), roboctrl::io::can::start(), roboctrl::io::serial::start(), roboctrl::io::tcp::start(), roboctrl::io::tcp_server::start() , 以及 roboctrl::io::udp::start().

stop()

void roboctrl::async::stop ( )

inline

在文件 async.hpp 第 282 行定义.

wait_for()

awaitable< void > roboctrl::async::wait_for ( const duration &  duration )

inline

协程任务等待。

参数

duration

等待时长

示例：

co_await wait_for(1ms);

在文件 async.hpp 第 262 行定义.

被这些函数引用 roboctrl::ctrl::robot::task(), roboctrl::ctrl::shoot::task() , 以及 roboctrl::device::dji_motor_group::task().

yield()

awaitable< void > roboctrl::async::yield ( )

inline

协程任务等待。用于让出当前函数的执行权。

示例：

co_await yield();

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