type Ref is new RTIDDS.Obj_Impl.Ref with private;
type Ref_Access is access all Ref'Class;
PARTICIPANT_QOS_DEFAULT : aliased DDS.DomainParticipantQos;
When used in DDS.DomainParticipantFactory.create_participant, this special value is used to indicate that the DDS.DomainParticipant should be created with the default DDS.DomainParticipant QoS by means of the operation DDS.DomainParticipantFactory.get_default_participant_qos() and using the resulting QoS to create the DDS.DomainParticipant.
When used in DDS.DomainParticipantFactory.set_default_participant_qos, this special value is used to indicate that the default QoS should be reset back to the initial value that would be used if the DDS.DomainParticipantFactory.set_default_participant_qos operation had never been called.
When used in DDS.DomainParticipant.set_qos, this special value is used to indicate that the QoS of the DDS.DomainParticipant should be changed to match the current default QoS set in the DDS.DomainParticipantFactory that the DDS.DomainParticipant belongs to.
RTI Connext treats this special value as a constant.
@warning This value is a constant and should never be modified. You cannot use this value to get the default QoS values from the DomainParticipant factory; for this purpose, use DDS.DomainParticipantFactory.get_default_participant_qos.
See also: NDDS_DISCOVERY_PEERS
See also: DDS.DomainParticipantFactory.create_participant()
See also: DDS.DomainParticipantFactory.set_default_participant_qos()
See also: DDS.DomainParticipant.set_qos()
function Get_Instance return Ref_Access;
DDSTheParticipantFactory can be used as an alias for the singleton factory returned by this operation.
Returns: The singleton DDS.DomainParticipantFactory instance.
MT Safety:
UNSAFE. In VxWorks, it is unsafe to call this procedure while another thread may be simultaneously calling DDS.DomainParticipantFactory.get_instance, DDS.DomainParticipantFactory.finalize_instance, DDS_TypeCodeFactory.get_instance, NDDSUtilityNetworkCapture.enable, or NDDSUtilityNetworkCapture.disable.
See also: DDSTheParticipantFactory
function Create_Participant
( | Self | : not null access Ref; |
Domain_Id | : in DDS.DomainId_T := Default_Domain; | |
Qos | : in DDS.DomainParticipantQos := PARTICIPANT_QOS_DEFAULT; | |
A_Listener | : in DDS.DomainParticipantListener.Ref_Access := null; | |
Mask | : in DDS.StatusMask := DDS.STATUS_MASK_NONE) return DDS.DomainParticipant.Ref_Access; |
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).
See also: dds::core::QosProvider
See also: DDS.DomainParticipantFactory.get_default_participant_qos
See also: DDS.DomainParticipant.set_listener
function Create_Participant_With_Profile
( | Self | : not null access Ref; |
Domain_Id | : in DDS.DomainId_T := Default_Domain; | |
library_name | : in DDS.String; | |
profile_name | : in DDS.String; | |
A_Listener | : in DDS.DomainParticipantListener.Ref_Access := null; | |
Mask | : in DDS.StatusMask := DDS.STATUS_MASK_NONE) return DDS.DomainParticipant.Ref_Access; |
function Create_Participant_With_Profile
( | Self | : not null access Ref; |
Domain_Id | : in DDS.DomainId_T := Default_Domain; | |
library_name | : in Standard.String; | |
profile_name | : in Standard.String; | |
A_Listener | : in DDS.DomainParticipantListener.Ref_Access := null; | |
Mask | : in DDS.StatusMask := DDS.STATUS_MASK_NONE) return DDS.DomainParticipant.Ref_Access; |
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).
@mtsafety_create_participant
self: <<in>> Cannot be NULL
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.StatusKind.
Returns: domain participant or NULL on failure
See also: DDSQosTypesModule_usage for information on setting QoS before entity creation
See also: DDS.DomainParticipantQos for rules on consistency among QoS
See also: DDS.PARTICIPANT_QOS_DEFAULT
See also: NDDS_DISCOVERY_PEERS
See also: DDS.DomainParticipantFactory.create_participant()
See also: DDS.DomainParticipantFactory.get_default_participant_qos()
See also: DDS.DomainParticipant.set_listener()
function Get_Or_Create_Participant
( | Self | : not null access Ref; |
Domain_Id | : in DDS.DomainId_T := Default_Domain; | |
Qos | : in DDS.DomainParticipantQos := DDS.DomainParticipantFactory.PARTICIPANT_QOS_DEFAULT; | |
A_Listener | : in DDS.DomainParticipantListener.Ref_Access := null; | |
Mask | : in DDS.StatusMask := STATUS_MASK_NONE) return DDS.DomainParticipant.Ref_Access; |
function Get_Or_Create_Participant_With_Profile
( | Self | : not null access Ref; |
Domain_Id | : in DDS.DomainId_T := Default_Domain; | |
Library_Name | : in DDS.String; | |
Profile_Name | : in DDS.String; | |
A_Listener | : in DDS.DomainParticipantListener.Ref_Access := null; | |
Mask | : in DDS.StatusMask := STATUS_MASK_NONE) return DDS.DomainParticipant.Ref_Access; |
procedure Delete_Participant
( | Self | : not null access Ref; |
A_Participant | : in out DDS.DomainParticipant.Ref_Access); |
Precondition: All domain entities belonging to the participant must have already been deleted. Otherwise it fails with the error DDS.RETCODE_PRECONDITION_NOT_MET.
Postcondition: Listener installed on the DDS.DomainParticipant will not be called after this procedure returns successfully.
@mtsafety_delete
self: <<in>> Cannot be NULL
a_participant: <<in>> DDS.DomainParticipant to be deleted.
Raises: One of the DDSReturnTypesModules_std_retcodes, or DDS.RETCODE_PRECONDITION_NOT_MET.
function Lookup_Participant
( | Self | : not null access Ref; |
Domain_Id | : in DDS.DomainId_T) return DDS.DomainParticipant.Ref_Access; |
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.
self: <<in>> Cannot be NULL
domainId: <<in>> ID of the domain participant to lookup.
Returns: domain participant if it exists, or NULL
procedure Set_Default_Participant_Qos
( | Self | : not null access Ref; |
Qos | : in DDS.DomainParticipantQos); |
This procedure may potentially allocate memory depending on the sequences contained in some QoS policies.
self: <<in>> Cannot be NULL
qos: <<inout>> Qos to be filled up. The special value DDS.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.
Raises: One of the DDSReturnTypesModules_std_retcodes
See also: DDS.PARTICIPANT_QOS_DEFAULT
See also: DDS.DomainParticipantFactory.create_participant
procedure Set_Default_Participant_Qos_with_Profile
( | Self | : not null access Ref; |
libraryName | : in DDS.String; | |
profile_name | : in DDS.String); |
This procedure 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.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_INCONSISTENT_POLICY
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
self: <<in>> 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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes, or DDS.RETCODE_INCONSISTENT_POLICY
See also: DDS.PARTICIPANT_QOS_DEFAULT
See also: DDS.DomainParticipantFactory.create_participant_with_profile
procedure Get_Default_Participant_Qos
( | Self | : not null access Ref; |
Qos | : in out DDS.DomainParticipantQos); |
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 procedure may potentially allocate memory depending on the sequences contained in some QoS policies.
self: <<in>> Cannot be NULL
qos: <<out>> the domain participant's QoS Cannot be NULL.
Raises: One of the DDSReturnTypesModules_std_retcodes
See also: DDS.PARTICIPANT_QOS_DEFAULT
See also: DDS.DomainParticipantFactory.create_participant
procedure Set_Qos
( | Self | : not null access Ref; |
Qos | : in DDS.DomainParticipantFactoryQos); |
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.
self: <<in>> Cannot be NULL
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 procedures except for DDS.DomainParticipantFactory.get_qos Cannot be NULL.
Raises: One of the DDSReturnTypesModules_std_retcodes, DDS.RETCODE_IMMUTABLE_POLICY if immutable policy is changed, or DDS.RETCODE_INCONSISTENT_POLICY if policies are inconsistent
See also: DDS.DomainParticipantFactoryQos for rules on consistency among QoS
procedure Load_Profiles
( | Self | : not null access Ref); |
The XML QoS profiles are loaded implicitly after the first DDS.DomainParticipant is created or explicitly, after a call to this procedure.
This has the same effect as DDS.DomainParticipantFactory.reload_profiles().
self: <<in>> Cannot be NULL
Raises: One of the DDSReturnTypesModules_std_retcodes
See also: DDS.ProfileQosPolicy
procedure Reload_Profiles
( | Self | : not null access Ref); |
The XML QoS profiles are loaded implicitly after the first DDS.DomainParticipant is created or explicitly, after a call to this procedure.
This has the same effect as DDS.DomainParticipantFactory.load_profiles().
self: <<in>> Cannot be NULL
Raises: One of the DDSReturnTypesModules_std_retcodes
See also: DDS.ProfileQosPolicy
procedure Unload_Profiles
( | Self | : not null access Ref); |
The resources associated with the XML QoS profiles are freed. Any reference to the profiles after calling this procedure will fail with an error.
self: <<in>> Cannot be NULL
Raises: One of the DDSReturnTypesModules_std_retcodes
See also: DDS.ProfileQosPolicy
procedure Set_Default_Profile
( | Self | : not null access Ref; |
library_name | : DDS.String; | |
profile_name | : DDS.String); |
This procedure 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 procedure. When calling a DDS.DomainParticipantFactory procedure that requires a profile_name parameter, you can use ull_value to refer to the default profile. (This same information applies to setting a default library.)
This procedure 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 ull_value after having called set_default_profile()).
Note: if the profile set with this function no longer exists after reloading the QoS profiles (for example, by changing DDS.DomainParticipantFactoryQos.profile) the default profile will be set to the last one marked with the attribute `is_default_qos=true` or ull_value no such profile exists.
self: <<in>> Cannot be NULL
library_name: <<in>> The library name containing the profile.
profile_name: <<in>> The profile name. If profile_name is ull_value any previous default is unset.
Raises: One of the DDSReturnTypesModules_std_retcodes
See also: DDS.DomainParticipantFactory.get_default_profile
See also: DDS.DomainParticipantFactory.get_default_profile_library
procedure set_default_library
( | Self | : not null access Ref; |
library_name | : DDS.String); |
Any API requiring a library_name as a parameter can use ull_value to refer to the default library set with this function.
Note: if the library set with this function no longer exists after reloading the QoS profiles (for example, by changing DDS.DomainParticipantFactoryQos.profile) the default library will be set to the last library containing a profile with the attribute `is_default_qos=true` or ull_value no such library exists.
See also: DDS.DomainParticipantFactory.set_default_profile for more information.
self: <<in>> Cannot be NULL
library_name: <<in>> Library name. If library_name is ull_value any previous default is unset.
Raises: One of the DDSReturnTypesModules_std_retcodes
See also: DDS.DomainParticipantFactory.get_default_library
function get_default_library
( | Self | : not null access Ref) return DDS.String; |
self: <<in>> Cannot be NULL
Returns: The returned library name is determined as follows:
See also: DDS.DomainParticipantFactory.set_default_library
function get_default_Profile
( | Self | : not null access Ref) return DDS.String; |
self: <<in>> Cannot be NULL
Returns: The returned profile name is determined as follows:
See also: DDS.DomainParticipantFactory.set_default_profile
function get_default_profile_library
( | Self | : not null access Ref) return DDS.String; |
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).
self: <<in>> Cannot be NULL
Returns: The default profile library for the profile returned by DDS.DomainParticipantFactory.get_default_profile, or ull_value if that profile is ull_value.
See also: DDS.DomainParticipantFactory.get_default_profile
procedure get_qos_profile_libraries
( | Self | : not null access Ref; |
libSeq | : not null access DDS.String_Seq.Sequence); |
function get_qos_profile_libraries
( | Self | : not null access Ref) return DDS.String_Seq.Sequence; |
self: <<in>> Cannot be NULL
library_names: <<out>> DDS.StringSeq to be filled with names of XML QoS profile libraries. Cannot be NULL.
procedure get_qos_profiles
( | Self | : not null access Ref; |
profSeq | : not null access DDS.String_Seq.Sequence; | |
libName | : in DDS.String); |
function get_qos_profiles
( | Self | : not null access Ref; |
libName | : in DDS.String) return DDS.String_Seq.Sequence; |
self: <<in>> Cannot be NULL
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).
procedure get_participant_qos_from_profile
( | Self | : not null access Ref; |
QoS | : in out DDS.DomainParticipantQos; | |
library_name | : DDS.String; | |
profile_name | : DDS.String); |
self: <<in>> Cannot be NULL
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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure get_publisher_qos_from_profile
( | Self | : not null access Ref; |
QoS | : in out DDS.PublisherQos; | |
library_name | : DDS.String; | |
profile_name | : DDS.String); |
self: <<in>> Cannot be NULL
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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure get_subscriber_qos_from_profile
( | Self | : not null access Ref; |
QoS | : in out DDS.SubscriberQos; | |
library_name | : DDS.String; | |
profile_name | : DDS.String); |
self: <<in>> Cannot be NULL
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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure get_datareader_qos_from_profile
( | Self | : not null access Ref; |
QoS | : in out DDS.DataReaderQos; | |
library_name | : DDS.String; | |
profile_name | : DDS.String); |
self: <<in>> Cannot be NULL
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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure get_datareader_qos_from_profile_w_topic_name
( | Self | : not null access Ref; |
QoS | : in out DDS.DataReaderQos; | |
library_name | : DDS.String; | |
profile_name | : DDS.String; | |
topic_name | : DDS.String); |
self: <<in>> Cannot be NULL
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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure get_datawriter_qos_from_profile
( | Self | : not null access Ref; |
QoS | : in out DDS.DataWriterQos; | |
library_name | : DDS.String; | |
profile_name | : DDS.String); |
self: <<in>> Cannot be NULL
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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure get_datawriter_qos_from_profile_w_topic_name
( | Self | : not null access Ref; |
QoS | : in out DDS.DataWriterQos; | |
library_name | : DDS.String; | |
profile_name | : DDS.String; | |
topic_name | : DDS.String); |
self: <<in>> Cannot be NULL
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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure get_topic_qos_from_profile
( | Self | : not null access Ref; |
QoS | : in out DDS.TopicQos; | |
library_name | : DDS.String; | |
profile_name | : DDS.String); |
self: <<in>> Cannot be NULL
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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure get_topic_qos_from_profile_w_topic_name
( | Self | : not null access Ref; |
QoS | : in out DDS.TopicQos; | |
library_name | : DDS.String; | |
profile_name | : DDS.String; | |
topic_name | : DDS.String); |
self: <<in>> Cannot be NULL
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 procedure fails with DDS.RETCODE_ERROR.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure Get_Qos
( | Self | : not null access Ref; |
Qos | : in out DDS.DomainParticipantFactoryQos); |
self: <<in>> Cannot be NULL
qos: <<inout>> QoS to be filled up. Cannot be NULL.
Raises: One of the DDSReturnTypesModules_std_retcodes
procedure Finalize_Instance
( | Self | : not null access Ref); |
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 procedure 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:
UNSAFE. In VxWorks, it is unsafe to call this procedure while another thread may be simultaneously calling DDS.DomainParticipantFactory.get_instance, DDS.DomainParticipantFactory.finalize_instance, DDS_TypeCodeFactory.get_instance, NDDSUtilityNetworkCapture.enable, or NDDSUtilityNetworkCapture.disable.
Raises: One of the DDSReturnTypesModules_std_retcodes, or DDS.RETCODE_PRECONDITION_NOT_MET
See also: DDSTheParticipantFactory
procedure Unregister_Thread
( | Self | : not null access Ref); |
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.
self: <<in>> Cannot be NULL
Raises: One of the DDSReturnTypesModules_std_retcodes
function GetInterface
( | Self | : not null access Ref) return DDS_DomainParticipantFactory_Access; |
procedure SetInterface
( | Self | : not null access Ref; |
To | : DDS_DomainParticipantFactory_Access); |
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() procedure, and destroyed with finalize_instance() procedure.
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:
See also: DDS.DomainParticipant