dds::domain Namespace Reference

Namespaces
	detail
	qos

Classes
class	DomainParticipant
	A DomainParticipant represents the local membership of the application in a Domain. More...
class	DomainParticipantListener
	DomainParticipant events Listener. More...
class	NoOpDomainParticipantListener
	DomainParticipant events Listener. More...

Functions
DomainParticipant	find (uint32_t id)
void	ignore (const dds::domain::DomainParticipant &dp, const dds::core::InstanceHandle &handle)
template<typename FwdIterator >
void	ignore (const dds::domain::DomainParticipant &dp, FwdIterator begin, FwdIterator end)

Function Documentation

find()

DomainParticipant dds::domain::find

(

uint32_t

id

)

This operation retrieves a previously-created DomainParticipant belonging to the specified domain_id. If no such DomainParticipant exists, the operation will return a dds::core::null DomainParticipant.

Parameters

id	the domain id

ignore() [1/2]

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

This operation allows an application to instruct the Service to locally ignore a remote domain participant. From that point onwards, the Service 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 domain participant.

This operation can be used, in conjunction with the discovery of remote participants offered by means of the "DCPSParticipant" built-in Topic, to provide, for example, access control. Application data can be associated with a DomainParticipant by means of the UserData. 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 domain participant to ignore is identified by the handle argument. This handle is the one that appears in the Sample retrieved when reading the data samples available for the built-in DataReader to the "DCPSParticipant" topic. The built-in DataReader is read with the same read/take operations used for any DataReader.

This operation is not required to be reversible. The Service offers no means to reverse it.

Parameters

dp	the DomainParticipant for which the remote entity will be ignored
handle	the InstanceHandle of the remote entity that has to be ignored

Exceptions

dds::core::OutOfResourcesError

if the Service is unable to ignore the indicated participant because internal resource has been exhausted.

ignore() [2/2]

template<typename FwdIterator >

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

This function enables you to ignore a series of entities whose instance handles are made available via the provided iterators.

This operation is not yet implemented. It is scheduled for a future release.

Parameters

dp	the DomainParticipant for which the remote entity will be ignored
begin	the begin iterator for the InstanceHandle to ignore
end	the end iterator for the InstanceHandle to ignore