rm::MqServer类 参考

消息队列服务端 更多...

#include <rmvl/io/ipc.hpp>

rm::MqServer 的协作图:

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

Protected 属性
std::string	_name {}
	消息队列名称
FileDescriptor	_mq {}
	消息队列描述符句柄

详细描述

消息队列服务端

构造及析构函数说明

MqServer() [1/3]

rm::MqServer::MqServer

(

std::string_view

name

)

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

构造消息队列服务端

参数

[in]

name

消息队列名称，必须以 '/' 开头，例如 "/test_mq"

MqServer() [2/3]

rm::MqServer::MqServer ( const MqServer & )

delete

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

函数调用图:

MqServer() [3/3]

rm::MqServer::MqServer ( MqServer && )

default

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

函数调用图:

~MqServer()

rm::MqServer::~MqServer

(

)

成员函数说明

operator<<()

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

inlinenoexcept

向消息队列写入数据

参数

[in]

data

待写入的数据

函数调用图:

operator=() [1/2]

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

delete

函数调用图:

operator=() [2/2]

MqServer & rm::MqServer::operator= ( MqServer && )

default

函数调用图:

operator>>()

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

inlinenoexcept

从消息队列读取数据

参数

[out]

data

读取到的数据

函数调用图:

read()

std::string rm::MqServer::read ( )

noexcept

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

从消息队列读取数据

返回

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

write()

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

noexcept

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

向消息队列写入数据

参数

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

返回

是否写入成功

类成员变量说明

_mq

FileDescriptor rm::MqServer::_mq {}

protected

消息队列描述符句柄

_name

std::string rm::MqServer::_name {}

protected

消息队列名称

---

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

• rmvl/io/ipc.hpp