Dds_discovery_api

Methods used to update the Graph Cache based on DDS discovery. More...

Functions
bool	rmw_dds_common::GraphCache::add_writer (const rmw_gid_t &writer_gid, const std::string &topic_name, const std::string &type_name, const rmw_gid_t &participant_gid, const rmw_qos_profile_t &qos)
	Add a data writer based on discovery. More...
bool	rmw_dds_common::GraphCache::add_reader (const rmw_gid_t &reader_gid, const std::string &topic_name, const std::string &type_name, const rmw_gid_t &participant_gid, const rmw_qos_profile_t &qos)
	Add a data reader based on discovery. More...
bool	rmw_dds_common::GraphCache::add_entity (const rmw_gid_t &gid, const std::string &topic_name, const std::string &type_name, const rmw_gid_t &participant_gid, const rmw_qos_profile_t &qos, bool is_reader)
	Add a data reader based on discovery. More...
bool	rmw_dds_common::GraphCache::remove_writer (const rmw_gid_t &gid)
	Remove a data writer based on discovery. More...
bool	rmw_dds_common::GraphCache::remove_reader (const rmw_gid_t &gid)
	Remove a data reader based on discovery. More...
bool	rmw_dds_common::GraphCache::remove_entity (const rmw_gid_t &gid, bool is_reader)
	Remove a data reader or writer based based on discovery. More...

Detailed Description

Methods used to update the Graph Cache based on DDS discovery.

Function Documentation

add_writer()

bool rmw_dds_common::GraphCache::add_writer	(	const rmw_gid_t &	writer_gid,
		const std::string &	topic_name,
		const std::string &	type_name,
		const rmw_gid_t &	participant_gid,
		const rmw_qos_profile_t &	qos
	)

Add a data writer based on discovery.

Parameters

gid	The data writer guid.
topic_name
type_name
participant_gid	gid of the participant.
qos	Quality of service of the writer.

Returns

true when a change took place.

add_reader()

bool rmw_dds_common::GraphCache::add_reader	(	const rmw_gid_t &	reader_gid,
		const std::string &	topic_name,
		const std::string &	type_name,
		const rmw_gid_t &	participant_gid,
		const rmw_qos_profile_t &	qos
	)

Add a data reader based on discovery.

Parameters

gid	The data reader guid
topic_name
type_name
participant_gid	gid of the participant.
qos	Quality of service of the writer.

Returns

true when a change took place.

add_entity()

bool rmw_dds_common::GraphCache::add_entity	(	const rmw_gid_t &	gid,
		const std::string &	topic_name,
		const std::string &	type_name,
		const rmw_gid_t &	participant_gid,
		const rmw_qos_profile_t &	qos,
		bool	is_reader
	)

Add a data reader based on discovery.

Parameters

gid	The data reader guid.
topic_name
type_name
participant_gid	gid of the participant.
qos	Quality of service of the writer.
is_reader	Adds a reader when true, if not a writer.

Returns

true when a change took place.

remove_writer()

bool rmw_dds_common::GraphCache::remove_writer

(

const rmw_gid_t &

gid

)

Remove a data writer based on discovery.

Parameters

gid	The data writer guid.

Returns

true when a change took place.

remove_reader()

bool rmw_dds_common::GraphCache::remove_reader

(

const rmw_gid_t &

gid

)

Remove a data reader based on discovery.

Parameters

gid	The data reader guid.

Returns

true when a change took place.

remove_entity()

bool rmw_dds_common::GraphCache::remove_entity	(	const rmw_gid_t &	gid,
		bool	is_reader
	)

Remove a data reader or writer based based on discovery.

Parameters

gid	The endpoint guid.
is_reader	true for removing a data reader.

Returns

true when a change took place.