<<singleton>> <<interface>> Allows creation and destruction of DDS::DomainParticipant objects. More...

#include <managed_domain.h>

Public Member Functions
void	set_default_participant_qos (DomainParticipantQos^ qos)
	Sets the default DDS::DomainParticipantQos values for this domain participant factory. More...

void	set_default_participant_qos_with_profile (System::String^ library_name, System::String^ profile_name)
	<<extension>> Sets the default DDS::DomainParticipantQos values for this domain participant factory based on the input XML QoS profile. More...

void	get_default_participant_qos (DomainParticipantQos^ qos)
	Initializes the DDS::DomainParticipantQos instance with default values. More...

void	set_default_library (System::String^ library_name)
	<<extension>> Sets the default XML library for a DDS::DomainParticipantFactory. More...

System::String ^	get_default_library ()
	<<extension>> Gets the default XML library associated with a DDS::DomainParticipantFactory. More...

void	set_default_profile (System::String^ library_name, System::String^ profile_name)
	<<extension>> Sets the default XML profile for a DDS::DomainParticipantFactory. More...

System::String ^	get_default_profile ()
	<<extension>> Gets the default XML profile associated with a DDS::DomainParticipantFactory. More...

System::String ^	get_default_profile_library ()
	<<extension>> Gets the library where the default XML profile is contained for a DDS::DomainParticipantFactory. More...

void	get_participant_factory_qos_from_profile (DomainParticipantFactoryQos^ qos, System::String^ library_name, System::String^ profile_name)
	<<extension>> Gets the DDS::DomainParticipantFactoryQos values associated with the input XML QoS profile. More...

void	get_participant_qos_from_profile (DomainParticipantQos^ qos, System::String^ library_name, System::String^ profile_name)
	<<extension>> Gets the DDS::DomainParticipantQos values associated with the input XML QoS profile. More...

void	get_publisher_qos_from_profile (PublisherQos^ qos, System::String^ library_name, System::String^ profile_name)
	<<extension>> Gets the DDS::PublisherQos values associated with the input XML QoS profile. More...

void	get_subscriber_qos_from_profile (SubscriberQos^ qos, System::String^ library_name, System::String^ profile_name)
	<<extension>> Gets the DDS::SubscriberQos values associated with the input XML QoS profile. More...

void	get_datawriter_qos_from_profile (DataWriterQos^ qos, System::String^ library_name, System::String^ profile_name)
	<<extension>> Gets the DDS::DataWriterQos values associated with the input XML QoS profile. More...

void	get_datawriter_qos_from_profile_w_topic_name (DataWriterQos^ qos, System::String^ library_name, System::String^ profile_name, System::String^ topic_name)
	<<extension>> Gets the DDS::DataWriterQos values associated with the input XML QoS profile while applying topic filters to the input topic name. More...

void	get_datareader_qos_from_profile (DataReaderQos^ qos, System::String^ library_name, System::String^ profile_name)
	<<extension>> Gets the DDS::DataReaderQos values associated with the input XML QoS profile. More...

void	get_datareader_qos_from_profile_w_topic_name (DataReaderQos^ qos, System::String^ library_name, System::String^ profile_name, System::String^ topic_name)
	<<extension>> Gets the DDS::DataReaderQos values associated with the input XML QoS profile while applying topic filters to the input topic name. More...

void	get_topic_qos_from_profile (TopicQos^ qos, System::String^ library_name, System::String^ profile_name)
	<<extension>> Gets the DDS::TopicQos values associated with the input XML QoS profile. More...

void	get_topic_qos_from_profile_w_topic_name (TopicQos^ qos, System::String^ library_name, System::String^ profile_name, System::String^ topic_name)
	<<extension>> Gets the DDS::TopicQos values associated with the input XML QoS profile while applying topic filters to the input topic name. More...

void	get_qos_profile_libraries (StringSeq^ library_names)
	<<extension>> Gets the names of all XML QoS profile libraries associated with the DDS::DomainParticipantFactory More...

void	get_qos_profiles (StringSeq^ profile_names, System::String^ library_name)
	<<extension>> Gets the names of all XML QoS profiles associated with the input XML QoS profile library. More...

DomainParticipant ^	create_participant (System::Int32 domainId, DomainParticipantQos^ qos, DomainParticipantListener^ listener, StatusMask mask)
	Creates a new DDS::DomainParticipant object. More...

DomainParticipant ^	create_participant_with_profile (System::Int32 domainId, System::String^ library_name, System::String^ profile_name, DomainParticipantListener^ listener, StatusMask mask)
	<<extension>> Creates a new DDS::DomainParticipant object using the DDS::DomainParticipantQos associated with the input XML QoS profile. More...

void	delete_participant (DomainParticipant^% a_participant)
	Deletes an existing DDS::DomainParticipant. More...

DomainParticipant ^	lookup_participant (Int32 domainId)
	Locates an existing DDS::DomainParticipant. More...

void	set_qos (DomainParticipantFactoryQos^ qos)
	Sets the value for a participant factory QoS. More...

void	get_qos (DomainParticipantFactoryQos^ qos)
	Gets the value for participant factory QoS. More...

void	load_profiles ()
	<<extension>> Loads the XML QoS profiles. More...

void	reload_profiles ()
	<<extension>> Reloads the XML QoS profiles. More...

void	unload_profiles ()
	<<extension>> Unloads the XML QoS profiles. More...

void	unregister_thread ()
	<<extension>> Allows the user to release thread specific resources kept by the middleware. More...

DomainParticipant ^	create_participant_from_config (String^ configuration_name)
	<<extension>> Creates a DDS::DomainParticipant given its configuration name from a description provided in an XML configuration file. More...

DomainParticipant ^	create_participant_from_config_w_params (String^ configuration_name, DomainParticipantConfigParams_t^ params)
	<<extension>> Creates a DDS::DomainParticipant given its configuration name from a description provided in an XML configuration file and a set of parameters that allow chaging some properties of such configuration. More...

DomainParticipant ^	lookup_participant_by_name (String^ participant_name)
	<<extension>> Looks up a DDS::DomainParticipant by its entity name in the DDS::DomainParticipantFactory. More...

void	register_type_support (TypeSupport^ type_support, String^ type_name)
	<<extension>> Registers a DDS::TypeSupport with the DDS::DomainParticipantFactory to enable automatic registration if the corresponding type, should it be needed by a DDS::DomainParticipant. More...

Static Public Member Functions
static DomainParticipantFactory ^	get_instance ()
	Gets the singleton instance of this class. More...

static void	finalize_instance ()
	<<extension>> Destroys the singleton instance of this class. More...

Properties
static DomainParticipantQos^	PARTICIPANT_QOS_DEFAULT `[get]`
	Special value for creating a DomainParticipant with default QoS. More...

static DomainParticipantConfigParams_t^	PARTICIPANT_CONFIG_PARAMS_DEFAULT `[get]`
	Special value for creating a DDS::DomainParticipant from configuration using default parameters. More...

Detailed Description

<<singleton>> <<interface>> Allows creation and destruction of DDS::DomainParticipant objects.

The sole purpose of this class is to allow the creation and destruction of DDS::DomainParticipant objects. This class itself is a <<singleton>>, and accessed via the get_instance() method, and destroyed with finalize_instance() method.

A single application can participate in multiple domains by instantiating multiple DDS::DomainParticipant objects.

An application may even instantiate multiple participants in the same domain. Participants in the same domain exchange data in the same way regardless of whether they are in the same application or different applications or on the same node or different nodes; their location is transparent.

There are two important caveats:

When there are multiple participants on the same node (in the same application or different applications) in the same domain, the application(s) must make sure that the participants do not try to bind to the same port numbers. You must disambiguate between the participants by setting a participant ID for each participant (DDS::WireProtocolQosPolicy::participant_id). The port numbers used by a participant are calculated based on both the participant index and the domain ID, so if all participants on the same node have different participant indexes, they can coexist in the same domain.
You cannot mix entities from different participants. For example, you cannot delete a topic on a different participant than you created it from, and you cannot ask a subscriber to create a reader for a topic created from a participant different than the subscriber's own participant. (Note that it is permissable for an application built on top of RTI Connext to know about entities from different participants. For example, an application could keep references to a reader from one domain and a writer from another and then bridge the domains by writing the data received in the reader callback.)

See also: DDS::DomainParticipant

Member Function Documentation

◆ get_instance()

static DomainParticipantFactory ^ DDS::DomainParticipantFactory::get_instance ( )

static

Gets the singleton instance of this class.

MT Safety:: On non-Linux systems: UNSAFE for multiple threads to simultaneously make the FIRST call to either DDS::DomainParticipantFactory::get_instance() or DDS::DomainParticipantFactory::finalize_instance(). Subsequent calls are thread safe. (On Linux systems, these calls are thread safe.)

Returns: The singleton DDS::DomainParticipantFactory instance.

Examples:: HelloWorld_publisher.cpp, HelloWorld_publisher.cs, HelloWorld_subscriber.cpp, and HelloWorld_subscriber.cs.

Referenced by RTI.Connext.Queuing.QueueConsumer< TRep >::QueueConsumer().

◆ finalize_instance()

static void DDS::DomainParticipantFactory::finalize_instance ( )

static

<<extension>> Destroys the singleton instance of this class.

Only necessary to explicitly reclaim resources used by the participant factory singleton. Note that on many OSs, these resources are automatically reclaimed by the OS when the program terminates. However, some memory-check tools still flag these as unreclaimed. So this method provides a way to clean up memory used by the participant factory.

Precondition: All participants created from the factory have been deleted.

Postcondition: All resources belonging to the factory have been reclaimed. Another call to DDS::DomainParticipantFactory::get_instance will return a new lifecycle of the singleton.

MT Safety:: On non-Linux systems: UNSAFE for multiple threads to simultaneously make the FIRST call to either DDS::DomainParticipantFactory::get_instance() or DDS::DomainParticipantFactory::finalize_instance(). Subsequent calls are thread safe. (On Linux systems, these calls are thread safe.)

Exceptions

One	of the Standard Return Codes, or DDS::Retcode_PreconditionNotMet

◆ set_default_participant_qos()

void DDS::DomainParticipantFactory::set_default_participant_qos ( DomainParticipantQos^ qos )

Sets the default DDS::DomainParticipantQos values for this domain participant factory.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

MT Safety:: UNSAFE. It is not safe to retrieve the default QoS value from a domain participant factory while another thread may be simultaneously calling DDS::DomainParticipantFactory::set_default_participant_qos

Parameters

qos <<inout>> Qos to be filled up. The special value DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if DDS::DomainParticipantFactory::set_default_participant_qos had never been called. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See also: DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT; DDS::DomainParticipantFactory::create_participant

◆ set_default_participant_qos_with_profile()

void DDS::DomainParticipantFactory::set_default_participant_qos_with_profile	(	System::String^	library_name,
		System::String^	profile_name
	)

<<extension>> Sets the default DDS::DomainParticipantQos values for this domain participant factory based on the input XML QoS profile.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

This default value will be used for newly created DDS::DomainParticipant if DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT is specified as the qos parameter when DDS::DomainParticipantFactory::create_participant is called.

Precondition: The DDS::DomainParticipantQos contained in the specified XML QoS profile must be consistent, or else the operation will have no effect and fail with DDS::Retcode_InconsistentPolicy

MT Safety:: UNSAFE. It is not safe to retrieve the default QoS value from a domain participant factory while another thread may be simultaneously calling DDS::DomainParticipantFactory::set_default_participant_qos

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).

If the input profile cannot be found the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy

See also: DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT; DDS::DomainParticipantFactory::create_participant_with_profile

◆ get_default_participant_qos()

void DDS::DomainParticipantFactory::get_default_participant_qos ( DomainParticipantQos^ qos )

Initializes the DDS::DomainParticipantQos instance with default values.

The retrieved qos will match the set of values specified on the last successful call to DDS::DomainParticipantFactory::set_default_participant_qos, or DDS::DomainParticipantFactory::set_default_participant_qos_with_profile, or else, if the call was never made, the default values listed in DDS::DomainParticipantQos.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

Parameters

qos	<<out>> the domain participant's QoS Cannot be NULL.

MT Safety:: UNSAFE. It is not safe to retrieve the default QoS value from a domain participant factory while another thread may be simultaneously calling DDS::DomainParticipantFactory::set_default_participant_qos

Exceptions

One	of the Standard Return Codes

See also: DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT; DDS::DomainParticipantFactory::create_participant

◆ set_default_library()

void DDS::DomainParticipantFactory::set_default_library ( System::String^ library_name )

<<extension>> Sets the default XML library for a DDS::DomainParticipantFactory.

Any API requiring a library_name as a parameter can use null to refer to the default library.

See also: DDS::DomainParticipantFactory::set_default_profile for more information.

Parameters

library_name <<in>> Library name. If library_name is null any previous default is unset.

Exceptions

One	of the Standard Return Codes

See also: DDS::DomainParticipantFactory::get_default_library

◆ get_default_library()

System::String ^ DDS::DomainParticipantFactory::get_default_library ( )

<<extension>> Gets the default XML library associated with a DDS::DomainParticipantFactory.

Returns: The default library or null if the default library was not set.

See also: DDS::DomainParticipantFactory::set_default_library

◆ set_default_profile()

void DDS::DomainParticipantFactory::set_default_profile	(	System::String^	library_name,
		System::String^	profile_name
	)

<<extension>> Sets the default XML profile for a DDS::DomainParticipantFactory.

This method specifies the profile that will be used as the default the next time a default DomainParticipantFactory profile is needed during a call to a DomainParticipantFactory method. When calling a DDS::DomainParticipantFactory method that requires a profile_name parameter, you can use NULL to refer to the default profile. (This same information applies to setting a default library.)

This method does not set the default QoS for newly created DomainParticipants; for this functionality, use DDS::DomainParticipantFactory::set_default_participant_qos_with_profile (you may pass in NULL after having called set_default_profile()).

Parameters

library_name	<<in>> The library name containing the profile.
profile_name	<<in>> The profile name. If profile_name is null any previous default is unset.

Exceptions

One	of the Standard Return Codes

See also: DDS::DomainParticipantFactory::get_default_profile; DDS::DomainParticipantFactory::get_default_profile_library

◆ get_default_profile()

System::String ^ DDS::DomainParticipantFactory::get_default_profile ( )

<<extension>> Gets the default XML profile associated with a DDS::DomainParticipantFactory.

Returns: The default profile or null if the default profile was not set.

See also: DDS::DomainParticipantFactory::set_default_profile

◆ get_default_profile_library()

System::String ^ DDS::DomainParticipantFactory::get_default_profile_library ( )

<<extension>> Gets the library where the default XML profile is contained for a DDS::DomainParticipantFactory.

The default profile library is automatically set when DDS::DomainParticipantFactory::set_default_profile is called.

This library can be different than the DDS::DomainParticipantFactory default library (see DDS::DomainParticipantFactory::get_default_library).

Returns: The default profile library or null if the default profile was not set.

See also: DDS::DomainParticipantFactory::set_default_profile

◆ get_participant_factory_qos_from_profile()

void DDS::DomainParticipantFactory::get_participant_factory_qos_from_profile	(	DomainParticipantFactoryQos^	qos,
		System::String^	library_name,
		System::String^	profile_name
	)

<<extension>> Gets the DDS::DomainParticipantFactoryQos values associated with the input XML QoS profile.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

◆ get_participant_qos_from_profile()

void DDS::DomainParticipantFactory::get_participant_qos_from_profile	(	DomainParticipantQos^	qos,
		System::String^	library_name,
		System::String^	profile_name
	)

<<extension>> Gets the DDS::DomainParticipantQos values associated with the input XML QoS profile.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

◆ get_publisher_qos_from_profile()

void DDS::DomainParticipantFactory::get_publisher_qos_from_profile	(	PublisherQos^	qos,
		System::String^	library_name,
		System::String^	profile_name
	)

<<extension>> Gets the DDS::PublisherQos values associated with the input XML QoS profile.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

◆ get_subscriber_qos_from_profile()

void DDS::DomainParticipantFactory::get_subscriber_qos_from_profile	(	SubscriberQos^	qos,
		System::String^	library_name,
		System::String^	profile_name
	)

<<extension>> Gets the DDS::SubscriberQos values associated with the input XML QoS profile.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

◆ get_datawriter_qos_from_profile()

void DDS::DomainParticipantFactory::get_datawriter_qos_from_profile	(	DataWriterQos^	qos,
		System::String^	library_name,
		System::String^	profile_name
	)

<<extension>> Gets the DDS::DataWriterQos values associated with the input XML QoS profile.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

◆ get_datawriter_qos_from_profile_w_topic_name()

void DDS::DomainParticipantFactory::get_datawriter_qos_from_profile_w_topic_name	(	DataWriterQos^	qos,
		System::String^	library_name,
		System::String^	profile_name,
		System::String^	topic_name
	)

<<extension>> Gets the DDS::DataWriterQos values associated with the input XML QoS profile while applying topic filters to the input topic name.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).
topic_name	<<in>> Topic name that will be evaluated against the topic_filter attribute in the XML QoS profile. If topic_name is null, RTI Connext will match only QoSs without explicit topic_filter expressions.

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

Referenced by RTI.Connext.Queuing.QueueConsumer< TRep >::QueueConsumer().

◆ get_datareader_qos_from_profile()

void DDS::DomainParticipantFactory::get_datareader_qos_from_profile	(	DataReaderQos^	qos,
		System::String^	library_name,
		System::String^	profile_name
	)

<<extension>> Gets the DDS::DataReaderQos values associated with the input XML QoS profile.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

◆ get_datareader_qos_from_profile_w_topic_name()

void DDS::DomainParticipantFactory::get_datareader_qos_from_profile_w_topic_name	(	DataReaderQos^	qos,
		System::String^	library_name,
		System::String^	profile_name,
		System::String^	topic_name
	)

<<extension>> Gets the DDS::DataReaderQos values associated with the input XML QoS profile while applying topic filters to the input topic name.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).
topic_name	<<in>> Topic name that will be evaluated against the topic_filter attribute in the XML QoS profile. If topic_name is null, RTI Connext will match only QoSs without explicit topic_filter expressions.

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

◆ get_topic_qos_from_profile()

void DDS::DomainParticipantFactory::get_topic_qos_from_profile	(	TopicQos^	qos,
		System::String^	library_name,
		System::String^	profile_name
	)

<<extension>> Gets the DDS::TopicQos values associated with the input XML QoS profile.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

◆ get_topic_qos_from_profile_w_topic_name()

void DDS::DomainParticipantFactory::get_topic_qos_from_profile_w_topic_name	(	TopicQos^	qos,
		System::String^	library_name,
		System::String^	profile_name,
		System::String^	topic_name
	)

<<extension>> Gets the DDS::TopicQos values associated with the input XML QoS profile while applying topic filters to the input topic name.

Parameters

qos	<<out>> Qos to be filled up. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).
topic_name	<<in>> Topic name that will be evaluated against the topic_filter attribute in the XML QoS profile. If topic_name is null, RTI Connext will match only QoSs without explicit topic_filter expressions.

If the input profile cannot be found, the method fails with DDS::Retcode_Error.

Exceptions

One	of the Standard Return Codes

◆ get_qos_profile_libraries()

void DDS::DomainParticipantFactory::get_qos_profile_libraries ( StringSeq^ library_names )

<<extension>> Gets the names of all XML QoS profile libraries associated with the DDS::DomainParticipantFactory

Parameters

library_names <<out>> DDS::StringSeq to be filled with names of XML QoS profile libraries. Cannot be NULL.

◆ get_qos_profiles()

void DDS::DomainParticipantFactory::get_qos_profiles	(	StringSeq^	profile_names,
		System::String^	library_name
	)

<<extension>> Gets the names of all XML QoS profiles associated with the input XML QoS profile library.

Parameters

profile_names	<<out>> DDS::StringSeq to be filled with names of XML QoS profiles. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).

◆ create_participant()

DomainParticipant ^ DDS::DomainParticipantFactory::create_participant	(	System::Int32	domainId,
		DomainParticipantQos^	qos,
		DomainParticipantListener^	listener,
		StatusMask	mask
	)

Creates a new DDS::DomainParticipant object.

Precondition: The specified QoS policies must be consistent or the operation will fail and no DDS::DomainParticipant will be created.

If you want to create multiple participants on a given host in the same domain, make sure each one has a different participant index (set in the DDS::WireProtocolQosPolicy). This in turn will ensure each participant uses a different port number (since the unicast port numbers are calculated from the participant index and the domain ID).

Note that if there is a single participant per host in a given domain, the participant index can be left at the default value (-1).

Parameters

domainId	<<in>> ID of the domain that the application intends to join. [range] [>=0], and does not violate guidelines stated in DDS::RtpsWellKnownPorts_t.
qos	<<in>> the DomainParticipant's QoS. The special value DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT can be used to indicate that the DDS::DomainParticipant should be created with the default DDS::DomainParticipantQos set in the DDS::DomainParticipantFactory. Cannot be NULL.
listener	<<in>> the domain participant's listener.
mask	<<in>>. Changes of communication status to be invoked on the listener. See DDS::StatusMask.

Returns: domain participant or NULL on failure

See also: Specifying QoS on entities for information on setting QoS before entity creation; DDS::DomainParticipantQos for rules on consistency among QoS; DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT; NDDS_DISCOVERY_PEERS; DDS::DomainParticipantFactory::create_participant_with_profile; DDS::DomainParticipantFactory::get_default_participant_qos; DDS::DomainParticipant::set_listener

Examples:: HelloWorld_publisher.cpp, HelloWorld_publisher.cs, HelloWorld_subscriber.cpp, and HelloWorld_subscriber.cs.

◆ create_participant_with_profile()

DomainParticipant ^ DDS::DomainParticipantFactory::create_participant_with_profile	(	System::Int32	domainId,
		System::String^	library_name,
		System::String^	profile_name,
		DomainParticipantListener^	listener,
		StatusMask	mask
	)

<<extension>> Creates a new DDS::DomainParticipant object using the DDS::DomainParticipantQos associated with the input XML QoS profile.

Precondition: The DDS::DomainParticipantQos in the input profile must be consistent, or the operation will fail and no DDS::DomainParticipant will be created.

If you want to create multiple participants on a given host in the same domain, make sure each one has a different participant index (set in the DDS::WireProtocolQosPolicy). This in turn will ensure each participant uses a different port number (since the unicast port numbers are calculated from the participant index and the domain ID).

Note that if there is a single participant per host in a given domain, the participant index can be left at the default value (-1).

Parameters

domainId	<<in>> ID of the domain that the application intends to join. [range] [>=0], and does not violate guidelines stated in DDS::RtpsWellKnownPorts_t.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see DDS::DomainParticipantFactory::set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS::DomainParticipantFactory::set_default_profile).
listener	<<in>> the DomainParticipant's listener.
mask	<<in>>. Changes of communication status to be invoked on the listener. See DDS::StatusMask.

Returns: domain participant or NULL on failure

See also: Specifying QoS on entities for information on setting QoS before entity creation; DDS::DomainParticipantQos for rules on consistency among QoS; DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT; NDDS_DISCOVERY_PEERS; DDS::DomainParticipantFactory::create_participant(); DDS::DomainParticipantFactory::get_default_participant_qos(); DDS::DomainParticipant::set_listener()

◆ delete_participant()

void DDS::DomainParticipantFactory::delete_participant ( DomainParticipant^% a_participant )

Deletes an existing DDS::DomainParticipant.

Precondition: All domain entities belonging to the participant must have already been deleted. Otherwise it fails with the error DDS::Retcode_PreconditionNotMet.

Postcondition: Listener installed on the DDS::DomainParticipant will not be called after this method returns successfully.

MT Safety:: UNSAFE. It is not safe to delete an entity while another thread may be simultaneously calling an API that uses the entity.

Parameters

a_participant <<in>> DDS::DomainParticipant to be deleted.

Exceptions

One	of the Standard Return Codes, or DDS::Retcode_PreconditionNotMet.

Examples:: HelloWorld_publisher.cpp, HelloWorld_publisher.cs, HelloWorld_subscriber.cpp, and HelloWorld_subscriber.cs.

◆ lookup_participant()

DomainParticipant ^ DDS::DomainParticipantFactory::lookup_participant ( Int32 domainId )

Locates an existing DDS::DomainParticipant.

If no such DDS::DomainParticipant exists, the operation will return NULL value.

If multiple DDS::DomainParticipant entities belonging to that domainId exist, then the operation will return one of them. It is not specified which one.

Parameters

domainId <<in>> ID of the domain participant to lookup.

Returns: domain participant if it exists, or NULL

◆ set_qos()

void DDS::DomainParticipantFactory::set_qos ( DomainParticipantFactoryQos^ qos )

Sets the value for a participant factory QoS.

The DDS::DomainParticipantFactoryQos::entity_factory can be changed. The other policies are immutable.

Note that despite having QoS, the DDS::DomainParticipantFactory is not an DDS::Entity.

Parameters

qos	<<in>> Set of policies to be applied to DDS::DomainParticipantFactory. Policies must be consistent. Immutable policies can only be changed before calling any other RTI Connext methods except for DDS::DomainParticipantFactory::get_qos Cannot be NULL.

Exceptions

One	of the Standard Return Codes, DDS::Retcode_ImmutablePolicy if immutable policy is changed, or DDS::Retcode_InconsistentPolicy if policies are inconsistent

See also: DDS::DomainParticipantFactoryQos for rules on consistency among QoS

◆ get_qos()

void DDS::DomainParticipantFactory::get_qos ( DomainParticipantFactoryQos^ qos )

Gets the value for participant factory QoS.

Parameters

qos	<<inout>> QoS to be filled up. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

◆ load_profiles()

void DDS::DomainParticipantFactory::load_profiles ( )

<<extension>> Loads the XML QoS profiles.

The XML QoS profiles are loaded implicitly after the first DDS::DomainParticipant is created or explicitly, after a call to this method.

This has the same effect as DDS::DomainParticipantFactory::reload_profiles().

Exceptions

One	of the Standard Return Codes

See also: DDS::ProfileQosPolicy

◆ reload_profiles()

void DDS::DomainParticipantFactory::reload_profiles ( )

<<extension>> Reloads the XML QoS profiles.

The XML QoS profiles are loaded implicitly after the first DDS::DomainParticipant is created or explicitly, after a call to this method.

This has the same effect as DDS::DomainParticipantFactory::load_profiles().

Exceptions

One	of the Standard Return Codes

See also: DDS::ProfileQosPolicy

◆ unload_profiles()

void DDS::DomainParticipantFactory::unload_profiles ( )

<<extension>> Unloads the XML QoS profiles.

The resources associated with the XML QoS profiles are freed. Any reference to the profiles after calling this method will fail with an error.

Exceptions

One	of the Standard Return Codes

See also: DDS::ProfileQosPolicy

◆ unregister_thread()

void DDS::DomainParticipantFactory::unregister_thread ( )

<<extension>> Allows the user to release thread specific resources kept by the middleware.

This function should be called by the user right before exiting a thread where DDS API were used. In this way the middleware will be able to free all the resources related to this specific thread. The best approach is to call the function during the thread deletion after all the DDS related API have have been called.

Exceptions

One	of the Standard Return Codes

◆ create_participant_from_config()

DomainParticipant ^ DDS::DomainParticipantFactory::create_participant_from_config ( String^ configuration_name )

<<extension>> Creates a DDS::DomainParticipant given its configuration name from a description provided in an XML configuration file.

This operation creates a DDS::DomainParticipant registering all the necessary data types and creating all the contained entities (DDS::Topic, DDS::Publisher, DDS::Subscriber, DDS::DataWriter, DDS::DataReader) from a description given in an XML configuration file.

The configuration name is the fully qualified name of the XML participant object, consisting of the name of the participant library plus the name of participant configuration.

For example the name "MyParticipantLibrary::PublicationParticipant" can be used to create the domain participant from the description in an XML file with contents shown in the snippet below:

<participant_library name="MyParticipantLibrary"> 
     <domain_participant name="PublicationParticipant" domain_ref="MyDomainLibrary::HelloWorldDomain"> 
         <publisher name="MyPublisher"> 
             <data_writer name="HelloWorldWriter" topic_ref="HelloWorldTopic"/> 
         </publisher> 
     </domain_participant> 
 </participant_library> 

The entities belonging to the newly created DDS::DomainParticipant can be retrieved with the help of lookup operations such as: DDS::DomainParticipant::lookup_datareader_by_name.

This operation is equivalent to call DDS::DomainParticipantFactory::create_participant_from_config_w_params passing DDS::DomainParticipantFactory::PARTICIPANT_CONFIG_PARAMS_DEFAULT as parameters.

Parameters

configuration_name <<in>> Name of the participant configuration in the XML file.

Returns: The created DDS::DomainParticipant or NULL on error.

See also: DDS::DomainParticipantFactory::lookup_participant_by_name; DDS::DomainParticipant::lookup_topicdescription; DDS::DomainParticipant::lookup_publisher_by_name; DDS::DomainParticipant::lookup_subscriber_by_name; DDS::DomainParticipant::lookup_datareader_by_name; DDS::DomainParticipant::lookup_datawriter_by_name; DDS::Publisher::lookup_datawriter_by_name; DDS::Subscriber::lookup_datareader_by_name

◆ create_participant_from_config_w_params()

DomainParticipant ^ DDS::DomainParticipantFactory::create_participant_from_config_w_params	(	String^	configuration_name,
		DomainParticipantConfigParams_t^	params
	)

<<extension>> Creates a DDS::DomainParticipant given its configuration name from a description provided in an XML configuration file and a set of parameters that allow chaging some properties of such configuration.

The operation will create a DDS::DomainParticipant the same way specified in DDS::DomainParticipantFactory::create_participant_from_config.

In addition, this operation allows overriding the domain ID, participant name, and entities QoS specified in the configuration.

Parameters

configuration_name	<<in>> Name of the participant configuration in the XML file.
params	<<in>> input parameters that allow changing some properties of the configuration referred to by `configuration_name`.

Returns: The created DDS::DomainParticipant or NULL on error.

◆ lookup_participant_by_name()

DomainParticipant ^ DDS::DomainParticipantFactory::lookup_participant_by_name ( String^ participant_name )

<<extension>> Looks up a DDS::DomainParticipant by its entity name in the DDS::DomainParticipantFactory.

Every DDS::DomainParticipant in the system has an entity name which is configured and stored in the EntityName policy, ENTITY_NAME.

This operation retrieves a DDS::DomainParticipant within the DDS::DomainParticipantFactory given the entity's name. If there are several DDS::DomainParticipant with the same name within the DDS::DomainParticipantFactory this function returns the first matching occurrence.

Parameters

participant_name <<in>> Entity name of the DDS::DomainParticipant.

Returns: The first DDS::DomainParticipant found with the specified name or NULL if it is not found.

◆ register_type_support()

void DDS::DomainParticipantFactory::register_type_support	(	TypeSupport^	type_support,
		String^	type_name
	)

<<extension>> Registers a DDS::TypeSupport with the DDS::DomainParticipantFactory to enable automatic registration if the corresponding type, should it be needed by a DDS::DomainParticipant.

Types refered by the DDS::Topic entities within a DDS::DomainParticipant must be registered with the DDS::DomainParticipant.

Type registration in a DDS::DomainParticipant is performed by a call to the FooTypeSupport::register_type operation. This can be done directly from the application code or indirectly by the RTI Connext infrastructure as a result of parsing an XML configuration file that refers to that type.

The DDS::DomainParticipantFactory::register_type_support operation provides the DDS::DomainParticipantFactory with the information it needs to automatically call the FooTypeSupport::register_type operation and register the corresponding type if the type is needed as a result of parsing an XML configuration file.

Automatic type registration while parsing XML files can also be done by the RTI Connext infrastructure based on the type description provided in the XML files. If the DDS::TypeSupport has been registered with the DDS::DomainParticipantFactory this definition takes precedence over the description of the type given in the XML file.

The DDS::DomainParticipantFactory::register_type_support operation receives a FooTypeSupport object as a parameter. This object's class is normally generated using rtiddsgen from a description of the corresponsing type in IDL, XML, or XSD.

The typical workflow when using this function is as follows: Define the data-type in IDL (or XML, or XSD) in a file. E.g. Foo.idl Run rtiddsgen in that file to generate the TypeSupport files, for the desired programming language. E.g. in C++ FooTypeSupport.h FooTypeSupport.cxx Include the proper header file (e.g. FooTypeSupport.h) in your program and call DDS::DomainParticipantFactory::register_type_support passing the function that was generated by rtiddsgen. E.g. FooTypeSupport::register_type Include the TypeSupport source file in your project such that it is compiled and linked. E.g. FooTypeSupport.cxx

You may refer to the Getting Started Guide for additional details in this process.

Note that only one register function is allowed per registered type name.

Parameters

type_support <<in>> DDS::TypeSupport object to be used for registering the type with a DDS::DomainParticipant.

Parameters

type_name <<in>> Name the type is registered with.

Exceptions

One	of the Standard Return Codes

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ get_instance()

◆ finalize_instance()

◆ set_default_participant_qos()

◆ set_default_participant_qos_with_profile()

◆ get_default_participant_qos()

◆ set_default_library()

◆ get_default_library()

◆ set_default_profile()

◆ get_default_profile()

◆ get_default_profile_library()

◆ get_participant_factory_qos_from_profile()

◆ get_participant_qos_from_profile()

◆ get_publisher_qos_from_profile()

◆ get_subscriber_qos_from_profile()

◆ get_datawriter_qos_from_profile()

◆ get_datawriter_qos_from_profile_w_topic_name()

◆ get_datareader_qos_from_profile()

◆ get_datareader_qos_from_profile_w_topic_name()

◆ get_topic_qos_from_profile()

◆ get_topic_qos_from_profile_w_topic_name()

◆ get_qos_profile_libraries()

◆ get_qos_profiles()

◆ create_participant()

◆ create_participant_with_profile()

◆ delete_participant()

◆ lookup_participant()

◆ set_qos()

◆ get_qos()

◆ load_profiles()

◆ reload_profiles()

◆ unload_profiles()

◆ unregister_thread()

◆ create_participant_from_config()

◆ create_participant_from_config_w_params()

◆ lookup_participant_by_name()

◆ register_type_support()