dds::domain Namespace Reference

The domain namespace contains types, classes, and functions related to DomainParticipants. More...

Namespaces
namespace	qos
	Contains DomainParticipantQos.

Classes
class	DomainParticipantListener
	The listener class for DomainParticipants. More...
class	DomainParticipant
	<<reference-type>> Container for all dds::core::Entity objects. More...

Functions
void	ignore (const dds::domain::DomainParticipant &participant, const dds::core::InstanceHandle &handle)
	Instructs RTI Connext to locally ignore a remote dds::domain::DomainParticipant.
template<typename FwdIterator >
void	ignore (const dds::domain::DomainParticipant &participant, FwdIterator begin, FwdIterator end)
	Instructs RTI Connext to locally ignore a group of remote dds::domain::DomainParticipant.
DomainParticipant	find (int32_t domain_id)
	Locates an existing dds::domain::DomainParticipant.

Detailed Description

The domain namespace contains types, classes, and functions related to DomainParticipants.

Function Documentation

void ignore	(	const dds::domain::DomainParticipant &	participant,
		const dds::core::InstanceHandle &	handle
	)

Instructs RTI Connext to locally ignore a remote dds::domain::DomainParticipant.

From the time of this call onwards, RTI Connext will locally behave as if the remote participant did not exist. This means it will ignore any topic, publication, or subscription that originates on that dds::domain::DomainParticipant.

There is no way to reverse this operation.

This operation can be used in conjunction with the discovery of remote participants offered by means of the dds::topic::ParticipantBuiltinTopicData to provide access control.

Application data can be associated with a dds::domain::DomainParticipant by means of the USER_DATA policy. This application data is propagated as a field in the built-in topic and can be used by an application to implement its own access control policy.

The dds::domain::DomainParticipant to ignore is identified by the handle argument. This handle is the one that appears in the dds::sub::SampleInfo retrieved when reading the data-samples available for the built-in dds::sub::DataReader to the dds::domain::DomainParticipant topic. The built-in dds::sub::DataReader is read with the same dds::sub::DataReader::read and dds::sub::DataReader::take operations used for any dds::sub::DataReader.

Parameters

participant	The DomainParticipant for which the remote entity will be ignored.
handle	The dds::core::InstanceHandle of the remote entity that will be ignored.

template<typename FwdIterator >

void ignore	(	const dds::domain::DomainParticipant &	participant,
		FwdIterator	begin,
		FwdIterator	end
	)

Instructs RTI Connext to locally ignore a group of remote dds::domain::DomainParticipant.

The series of entities whose instance handles are made available via the provided iterators will be ignored.

Parameters

participant	The DomainParticipant for which the remote entity will be ignored
begin	The begin iterator for the series of InstanceHandles to ignore
end	The end iterator for the series of InstanceHandles to ignore

See Also

ignore(const dds::domain::DomainParticipant& participant, const dds::core::InstanceHandle& handle)

DomainParticipant find

(

int32_t

domain_id

)

Locates an existing dds::domain::DomainParticipant.

If no such DomainParticipant exists, the operation will return dds::core::null.

If multiple DomainParticipants belonging to that domain id exist, then the operation will return one of them. It is not specified which one.

Parameters

domain_id

The domain id of the DomainParticipant to find