dds::topic Namespace Reference

Namespaces
	qos

Classes
class	AnyTopic
	Typeless base class for the typed Topic. More...
class	AnyTopicListener
	AnyTopic events Listener. More...
class	BuiltinTopicKey
	Global unique identifier of the Topic. More...
class	ContentFilteredTopic
	ContentFilteredTopic is a specialization of TopicDescription that allows for content-based subscriptions. More...
class	Filter
	Filter objects contain SQL expressions that allow the application to specify a filter on the locally available data. More...
struct	is_topic_type
	Support functionality to check if a given object type is a Topic. More...
class	NoOpAnyTopicListener
	AnyTopic events Listener. More...
class	NoOpTopicListener
	Topic events Listener. More...
class	ParticipantBuiltinTopicData
	Class that contains information about available DomainParticipants within the system. More...
class	PublicationBuiltinTopicData
	Class that contains information about available DataWriters within the system. More...
class	SubscriptionBuiltinTopicData
	Class that contains information about available DataReaders within the system. More...
class	Topic
	Topic is the most basic description of the data to be published and subscribed. More...
struct	topic_type_name
	Support functionality to get the default type_name of a Topic type. More...
class	TopicBuiltinTopicData
	Class that contains information about available Topics within the system. More...
class	TopicDescription
	This class is the base for Topic, ContentFilteredTopic and MultiTopic. More...
class	TopicInstance
	A TopicInstance encapsulates a dds::sub::Sample and its associated dds::core::InstanceHandle. More...
class	TopicListener
	Topic events Listener. More...

Functions
template<typename TOPIC >
TOPIC	discover (const dds::domain::DomainParticipant &dp, const std::string &name, const dds::core::Duration &timeout=dds::core::Duration::infinite())
template<typename ANYTOPIC , typename FwdIterator >
uint32_t	discover (const dds::domain::DomainParticipant &dp, FwdIterator begin, uint32_t max_size)
template<typename ANYTOPIC , typename BinIterator >
uint32_t	discover_all (const dds::domain::DomainParticipant &dp, BinIterator begin)
template<typename TOPIC >
TOPIC	find (const dds::domain::DomainParticipant &dp, const std::string &topic_name)
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

discover() [1/2]

template<typename TOPIC >

TOPIC dds::topic::discover	(	const dds::domain::DomainParticipant &	dp,
		const std::string &	name,
		const dds::core::Duration &	timeout = dds::core::Duration::infinite()
	)

This operation gives access to an specific existing (or ready to exist) enabled Topic, ContentFilteredTopic, MultiTopic, AnyTopic or TopicDescription based on its topic_name.

Topics that the application has indicated should be 'ignored' (by means of the dds::topic::ignore operation) will not appear in this list (note: the ignore feature is not yet supported).

If a Topic of the same topic_name already exists, it gives access to this Topic. Otherwise it waits (blocks the caller) until another mechanism creates it. This other mechanism can be another thread, a configuration tool, or some other Data Distribution Service utility. If after the specified timeout the Topic can still not be found, the caller gets unblocked and the returned Topic will be dds::core::null.

A Topic that is obtained by means of find_topic in a specific DomainParticipant can only be used to create DataReaders and DataWriters in that DomainParticipant.

This operation usually results in network look-ups.

For finding only locally created Topics, look here.

Parameters

dp	the DomainParticipant
name	the topic name to discover
timeout	the time out

Exceptions

dds::core::Error	An internal error has occurred.
dds::core::NullReferenceError	The DomainParticipant was not properly created and references to dds::core::null.
dds::core::AlreadyClosedError	The DomainParticipant has already been closed.
dds::core::NotEnabledError	The DomainParticipant has not yet been enabled.
dds::core::OutOfResourcesError	The Data Distribution Service ran out of resources to complete this operation.
dds::core::TimeoutError	No Topics of the given name found within the timeout.

discover() [2/2]

template<typename ANYTOPIC , typename FwdIterator >

uint32_t dds::topic::discover	(	const dds::domain::DomainParticipant &	dp,
		FwdIterator	begin,
		uint32_t	max_size
	)

This operation retrieves a list of Topics that have been discovered in the domain.

If the max_size of the given list is large enough, all discovered Topics will be present in that list. Otherwise, a random sub-set of max_size elements is returned.

Topics that the application has indicated should be 'ignored' (by means of the dds::topic::ignore operation) will not appear in this list (note: the ignore feature is not yet supported).

Because Topics of various different kinds can be retrieved, the list contains AnyTopics.

This operation usually results in network look-ups.

Parameters

dp	the DomainParticipant
begin	a forward iterator pointing to the beginning of a container in which to insert the topics
max_size	the maximum number of topics to return

discover_all()

template<typename ANYTOPIC , typename BinIterator >

uint32_t dds::topic::discover_all	(	const dds::domain::DomainParticipant &	dp,
		BinIterator	begin
	)

This operation retrieves a list of all Topics that have been discovered in the domain.

Topics that the application has indicated should be 'ignored' (by means of the dds::topic::ignore operation) will not appear in this list (note: the ignore feature is not yet supported).

Because Topics of various different kinds can be retrieved, the list contains AnyTopics.

This operation usually results in network look-ups.

Parameters

dp	the DomainParticipant
begin	a back inserting iterator pointing to the beginning of a container in which to insert the topics

find()

template<typename TOPIC >

TOPIC dds::topic::find	(	const dds::domain::DomainParticipant &	dp,
		const std::string &	topic_name
	)

This operation gives access to a locally-created Topic, ContentFilteredTopic, MultiTopic, AnyTopic and TopicDescription with a matching name.

dds::topic::find will never create a Topic but returns a reference to an Topic proxy that already exists locally. When no local proxy exists, the returned Topic will be a dds::core::null object. The operation never blocks.

For discovering globally available Topics, look here.

Parameters

dp	the DomainParticipant to find the topic on
topic_name	the topic name to find

ignore() [1/2]

void dds::topic::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 is not yet implemented. It is scheduled for a future release.

Parameters

dp	the DomainParticipant
handle	the handle of the DomainParticipant to ignore

ignore() [2/2]

template<typename FwdIterator >

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

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 is not yet implemented. It is scheduled for a future release.

Parameters

dp	the DomainParticipant
begin	a forward iterator pointing to the beginning of a sequence of InstanceHandles to ignore
end	a forward iterator pointing to the end of a sequence of InstanceHandles to ignore