roboctrl::io::udp类 参考

UDP 通信端点。 更多...

详细描述

UDP 通信端点。

在文件 udp.h 第 23 行定义.

#include <udp.h>

类 roboctrl::io::udp 继承关系图:

roboctrl::io::udp 的协作图:

类
struct	info_type
	UDP 初始化参数。 更多...

Public 成员函数
	udp (info_type info)
	构造并连接到指定远端。
void	start ()
	启动 UDP 接收协程；重复调用不会重复启动。
awaitable< void >	send (byte_span data)
	异步发送一段字节数据。
awaitable< void >	task ()
	接收循环任务。
std::string	desc () const
	返回 UDP 端点描述。
Public 成员函数 继承自 roboctrl::io::bare_io_base
void	on_data (callback_fn< byte_span > auto fn)
	注册字节级别的回调。
template<detail::typed_callback_fn Fn> requires (!std::same_as<std::remove_cvref_t<utils::function_arg_t<Fn>>,byte_span>)
void	on_data (Fn &&fn)
Public 成员函数 继承自 roboctrl::utils::immovable_base
	immovable_base (immovable_base &&)=delete
immovable_base &	operator= (immovable_base &&)=delete
Public 成员函数 继承自 roboctrl::utils::not_copyable_base
	not_copyable_base (const not_copyable_base &)=delete
not_copyable_base &	operator= (const not_copyable_base &)=delete

额外继承的成员函数
Protected 成员函数 继承自 roboctrl::io::bare_io_base
void	dispatch (byte_span bytes)
	分发收到的字节流。

构造及析构函数说明

udp()

udp::udp

(

info_type

info

)

构造并连接到指定远端。

在文件 udp.cpp 第 9 行定义.

引用了 roboctrl::async::executor().

成员函数说明

desc()

std::string roboctrl::io::udp::desc ( ) const

inline

返回 UDP 端点描述。

在文件 udp.h 第 60 行定义.

send()

roboctrl::awaitable< void > udp::send

(

byte_span

data

)

异步发送一段字节数据。

在文件 udp.cpp 第 32 行定义.

start()

void udp::start

(

)

启动 UDP 接收协程；重复调用不会重复启动。

在文件 udp.cpp 第 24 行定义.

引用了 roboctrl::async::spawn() , 以及 task().

task()

roboctrl::awaitable< void > udp::task

(

)

接收循环任务。

在文件 udp.cpp 第 37 行定义.

引用了 roboctrl::io::bare_io_base::dispatch().

被这些函数引用 start().

---

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

• /home/runner/work/GKD.RoboCtrl/GKD.RoboCtrl/include/io/udp.h
• io/udp.cpp