rm::MqClient类 参考

消息队列客户端 更多...

#include <rmvl/io/ipc.hpp>

rm::MqClient 的协作图:

Public 成员函数
	MqClient (std::string_view name)
	构造消息队列客户端
	MqClient (const MqClient &)=delete
	MqClient (MqClient &&)=default
MqClient &	operator= (const MqClient &)=delete
MqClient &	operator= (MqClient &&)=default
	~MqClient ()
std::string	read () noexcept
	从消息队列读取数据
MqClient &	operator>> (std::string &data) noexcept
	从消息队列读取数据
bool	write (std::string_view data, uint32_t prio=0) noexcept
	向消息队列写入数据
MqClient &	operator<< (std::string_view data) noexcept
	向消息队列写入数据

Protected 属性
int	_mq {}
	消息队列描述符

详细描述

消息队列客户端

构造及析构函数说明

MqClient() [1/3]

rm::MqClient::MqClient

(

std::string_view

name

)

Python:
	rm.MqClient(	name	) ->	<MqClient object>

构造消息队列客户端

参数

[in]

name

消息队列名称

MqClient() [2/3]

rm::MqClient::MqClient ( const MqClient & )

delete

Python:
	rm.MqClient(	name	) ->	<MqClient object>

函数调用图:

MqClient() [3/3]

rm::MqClient::MqClient ( MqClient && )

default

Python:
	rm.MqClient(	name	) ->	<MqClient object>

函数调用图:

~MqClient()

rm::MqClient::~MqClient

(

)

成员函数说明

operator<<()

MqClient & rm::MqClient::operator<< ( std::string_view data )

inlinenoexcept

向消息队列写入数据

参数

[in]

data

待写入的数据

函数调用图:

operator=() [1/2]

MqClient & rm::MqClient::operator= ( const MqClient & )

delete

函数调用图:

operator=() [2/2]

MqClient & rm::MqClient::operator= ( MqClient && )

default

函数调用图:

operator>>()

MqClient & rm::MqClient::operator>> ( std::string & data )

inlinenoexcept

从消息队列读取数据

参数

[out]

data

读取到的数据

函数调用图:

read()

std::string rm::MqClient::read ( )

noexcept

Python:
	rm.MqClient.read(		) ->	data

从消息队列读取数据

返回

读取到的数据，成功时返回非空字符串，失败时返回空字符串

write()

bool rm::MqClient::write ( std::string_view data, uint32_t prio = 0 )

noexcept

Python:
	rm.MqClient.write(	data	) ->	res

向消息队列写入数据

参数

[in]	data	待写入的数据
[in]	prio	消息优先级，数值越大优先级越高，相同优先级的消息按照 FIFO 处理

返回

是否写入成功

类成员变量说明

_mq

int rm::MqClient::_mq {}

protected

消息队列描述符

---

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

• rmvl/io/ipc.hpp