RTI Connext Java API Version 7.3.0
|
<<interface>> Container for all com.rti.dds.infrastructure.DomainEntity objects. More...
<<interface>> Container for all com.rti.dds.infrastructure.DomainEntity objects.
The DomainParticipant object plays several roles:
domainId
and isolating them from applications running on different domains. In this way, several independent distributed applications can coexist in the same physical network without interfering, or even being aware of each other. The following operations may be called even if the com.rti.dds.domain.DomainParticipant is not enabled. Operations NOT in this list will fail with com.rti.dds.infrastructure.RETCODE_NOT_ENABLED \ if called on a disabled DomainParticipant.
void get_default_flowcontroller_property | ( | FlowControllerProperty_t | prop | ) |
<<extension>> Copies the default com.rti.dds.publication.FlowControllerProperty_t values for this domain participant into the given com.rti.dds.publication.FlowControllerProperty_t instance.
The retrieved property
will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property, or else, if the call was never made, the default values listed in com.rti.dds.publication.FlowControllerProperty_t.
prop | <<in>> Default property to be retrieved. Cannot be NULL. |
One | of the Standard Return Codes |
void set_default_flowcontroller_property | ( | FlowControllerProperty_t | prop | ) |
<<extension>> Set the default com.rti.dds.publication.FlowControllerProperty_t values for this domain participant.
This default value will be used for newly created com.rti.dds.publication.FlowController if com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT is specified as the property
parameter when com.rti.dds.domain.DomainParticipant.create_flowcontroller is called.
qos
parameter. prop | <<in>> Default property to be set. The special value com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT may be passed as property to indicate that the default property should be reset to the default values the factory would use if com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void get_default_topic_qos | ( | TopicQos | qos | ) |
Copies the default com.rti.dds.topic.TopicQos values for this domain participant into the given com.rti.dds.topic.TopicQos instance.
The retrieved qos
will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_topic_qos, or com.rti.dds.domain.DomainParticipant.set_default_topic_qos_with_profile or else, if the call was never made, the default values listed in com.rti.dds.topic.TopicQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<in>> Default qos to be retrieved. Cannot be NULL. |
One | of the Standard Return Codes |
void set_default_topic_qos | ( | TopicQos | qos | ) |
Set the default com.rti.dds.topic.TopicQos values for this domain participant.
This default value will be used for newly created com.rti.dds.topic.Topic if com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT is specified as the qos
parameter when com.rti.dds.domain.DomainParticipant.create_topic is called.
qos
parameter. qos | <<in>> Default qos to be set. The special value com.rti.dds.domain.DomainParticipant.TOPIC_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 com.rti.dds.domain.DomainParticipant.set_default_topic_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void set_default_topic_qos_with_profile | ( | String | library_name, |
String | profile_name | ||
) |
<<extension>> Set the default com.rti.dds.topic.TopicQos values for this domain participant based on the input XML QoS profile.
This default value will be used for newly created com.rti.dds.topic.Topic if com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT is specified as the qos
parameter when com.rti.dds.domain.DomainParticipant.create_topic is called.
qos
parameter. library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
If the input profile cannot be found the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void get_default_publisher_qos | ( | PublisherQos | qos | ) |
Copy the default com.rti.dds.publication.PublisherQos values into the provided com.rti.dds.publication.PublisherQos instance.
The retrieved qos
will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_publisher_qos, or com.rti.dds.domain.DomainParticipant.set_default_publisher_qos_with_profile, or else, if the call was never made, the default values listed in com.rti.dds.publication.PublisherQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
If com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT is specified as the qos
parameter when com.rti.dds.domain.DomainParticipant.create_topic is called, the default value of the QoS set in the factory, equivalent to the value obtained by calling com.rti.dds.domain.DomainParticipant.get_default_publisher_qos, will be used to create the com.rti.dds.publication.Publisher.
qos | <<inout>> Qos to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void set_default_publisher_qos | ( | PublisherQos | qos | ) |
Set the default com.rti.dds.publication.PublisherQos values for this DomainParticipant.
This set of default values will be used for a newly created com.rti.dds.publication.Publisher if com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT is specified as the qos
parameter when com.rti.dds.domain.DomainParticipant.create_publisher is called.
qos
parameter. qos | <<in>> Default qos to be set. The special value com.rti.dds.domain.DomainParticipant.PUBLISHER_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 com.rti.dds.domain.DomainParticipant.set_default_publisher_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void set_default_publisher_qos_with_profile | ( | String | library_name, |
String | profile_name | ||
) |
<<extension>> Set the default com.rti.dds.publication.PublisherQos values for this DomainParticipant based on the input XML QoS profile.
This set of default values will be used for a newly created com.rti.dds.publication.Publisher if com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT is specified as the qos
parameter when com.rti.dds.domain.DomainParticipant.create_publisher is called.
qos
parameter. library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
If the input profile cannot be found, the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void get_default_datawriter_qos | ( | DataWriterQos | qos | ) |
<<extension>> Copy the default com.rti.dds.publication.DataWriterQos values into the provided com.rti.dds.publication.DataWriterQos instance.
The retrieved qos
will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos, or com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos_with_profile, or else, if the call was never made, the default values listed in com.rti.dds.publication.DataWriterQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<inout>> Qos to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void set_default_datawriter_qos | ( | DataWriterQos | qos | ) |
<<extension>> Set the default DataWriterQos values for this DomainParticipant.
This set of default values will be inherited for a newly created com.rti.dds.publication.Publisher.
qos
parameter. qos | <<in>> Default qos to be set. The special value com.rti.dds.publication.Publisher.DATAWRITER_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 com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void set_default_datawriter_qos_with_profile | ( | String | library_name, |
String | profile_name | ||
) |
<<extension>> Set the default com.rti.dds.publication.DataWriterQos values for this domain participant based on the input XML QoS profile.
This set of default values will be inherited for a newly created com.rti.dds.publication.Publisher.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
If the input profile cannot be found, the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void get_default_datareader_qos | ( | DataReaderQos | qos | ) |
<<extension>> Copy the default com.rti.dds.subscription.DataReaderQos values into the provided com.rti.dds.subscription.DataReaderQos instance.
The retrieved qos
will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_datareader_qos, or com.rti.dds.domain.DomainParticipant.set_default_datareader_qos_with_profile, or else, if the call was never made, the default values listed in com.rti.dds.subscription.DataReaderQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<inout>> Qos to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void set_default_subscriber_qos | ( | SubscriberQos | qos | ) |
Set the default com.rti.dds.subscription.SubscriberQos values for this DomainParticipant.
This set of default values will be used for a newly created com.rti.dds.subscription.Subscriber if com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT is specified as the qos
parameter when com.rti.dds.domain.DomainParticipant.create_subscriber is called.
qos
parameter. qos | <<in>> Default qos to be set. The special value com.rti.dds.domain.DomainParticipant.SUBSCRIBER_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 com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void set_default_subscriber_qos_with_profile | ( | String | library_name, |
String | profile_name | ||
) |
<<extension>> Set the default com.rti.dds.subscription.SubscriberQos values for this DomainParticipant based on the input XML QoS profile.
This set of default values will be used for a newly created com.rti.dds.subscription.Subscriber if com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT is specified as the qos
parameter when com.rti.dds.domain.DomainParticipant.create_subscriber is called.
qos
parameter. library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
If the input profile cannot be found, the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void get_default_subscriber_qos | ( | SubscriberQos | qos | ) |
Copy the default com.rti.dds.subscription.SubscriberQos values into the provided com.rti.dds.subscription.SubscriberQos instance.
The retrieved qos
will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos, or com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos_with_profile, or else, if the call was never made, the default values listed in com.rti.dds.subscription.SubscriberQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
If com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT is specified as the qos
parameter when com.rti.dds.domain.DomainParticipant.create_subscriber is called, the default value of the QoS set in the factory, equivalent to the value obtained by calling com.rti.dds.domain.DomainParticipant.get_default_subscriber_qos, will be used to create the com.rti.dds.subscription.Subscriber.
qos | <<inout>> Qos to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void set_default_datareader_qos | ( | DataReaderQos | qos | ) |
<<extension>> Set the default com.rti.dds.subscription.DataReaderQos values for this domain participant.
This set of default values will be inherited for a newly created com.rti.dds.subscription.Subscriber.
qos | <<in>> Default qos to be set. The special value com.rti.dds.subscription.Subscriber.DATAREADER_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 com.rti.dds.domain.DomainParticipant.set_default_datareader_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
void set_default_datareader_qos_with_profile | ( | String | library_name, |
String | profile_name | ||
) |
<<extension>> Set the default com.rti.dds.subscription.DataReaderQos values for this DomainParticipant based on the input XML QoS profile.
This set of default values will be inherited for a newly created com.rti.dds.subscription.Subscriber.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
If the input profile cannot be found, the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY |
FlowController create_flowcontroller | ( | String | name, |
FlowControllerProperty_t | prop | ||
) |
<<extension>> Creates a com.rti.dds.publication.FlowController with the desired property.
The created com.rti.dds.publication.FlowController is associated with a com.rti.dds.publication.DataWriter via com.rti.dds.infrastructure.PublishModeQosPolicy.flow_controller_name. A single FlowController may service multiple DataWriters instances, even if they belong to a different com.rti.dds.publication.Publisher. The property
determines how the FlowController shapes the network traffic.
property
must be consistent, or the operation will fail and no com.rti.dds.publication.FlowController will be created. property
, it is not safe to create the flow controller while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property or trying to lookup that flow controller with com.rti.dds.domain.DomainParticipant.lookup_flowcontroller. name | <<in>> name of the com.rti.dds.publication.FlowController to create. A com.rti.dds.publication.DataWriter is associated with a com.rti.dds.publication.FlowController by name. Limited to 255 characters. |
prop | <<in>> property to be used for creating the new com.rti.dds.publication.FlowController. The special value com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT can be used to indicate that the com.rti.dds.publication.FlowController should be created with the default com.rti.dds.publication.FlowControllerProperty_t set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL. |
void delete_flowcontroller | ( | FlowController | fc | ) |
<<extension>> Deletes an existing com.rti.dds.publication.FlowController.
fc | <<in>> The com.rti.dds.publication.FlowController to be deleted. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET. |
Publisher create_publisher | ( | PublisherQos | qos, |
PublisherListener | listener, | ||
int | mask | ||
) |
Creates a com.rti.dds.publication.Publisher with the desired QoS policies and attaches to it the specified com.rti.dds.publication.PublisherListener.
qos
, it is not safe to create the publisher while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_publisher_qos. qos | <<in>> QoS to be used for creating the new com.rti.dds.publication.Publisher. The special value com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT can be used to indicate that the com.rti.dds.publication.Publisher should be created with the default com.rti.dds.publication.PublisherQos set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL. |
listener | <<in>>. Listener to be attached to the newly created com.rti.dds.publication.Publisher. |
mask | <<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask. |
Publisher create_publisher_with_profile | ( | String | library_name, |
String | profile_name, | ||
PublisherListener | listener, | ||
int | mask | ||
) |
<<extension>> Creates a new com.rti.dds.publication.Publisher object using the com.rti.dds.publication.PublisherQos associated with the input XML QoS profile.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
listener | <<in>>. Listener to be attached to the newly created com.rti.dds.publication.Publisher. |
mask | <<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask. |
void delete_publisher | ( | Publisher | p | ) |
Deletes an existing com.rti.dds.publication.Publisher.
p | <<in>> com.rti.dds.publication.Publisher to be deleted. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET. |
Subscriber create_subscriber | ( | SubscriberQos | qos, |
SubscriberListener | listener, | ||
int | mask | ||
) |
Creates a com.rti.dds.subscription.Subscriber with the desired QoS policies and attaches to it the specified com.rti.dds.subscription.SubscriberListener.
qos
, it is not safe to create the subscriber while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos. qos | <<in>> QoS to be used for creating the new com.rti.dds.subscription.Subscriber. The special value com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT can be used to indicate that the com.rti.dds.subscription.Subscriber should be created with the default com.rti.dds.subscription.SubscriberQos set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL. |
listener | <<in>>. Listener to be attached to the newly created com.rti.dds.subscription.Subscriber. |
mask | <<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask. |
Subscriber create_subscriber_with_profile | ( | String | library_name, |
String | profile_name, | ||
SubscriberListener | listener, | ||
int | mask | ||
) |
<<extension>> Creates a new com.rti.dds.subscription.Subscriber object using the com.rti.dds.publication.PublisherQos associated with the input XML QoS profile.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
listener | <<in>>. Listener to be attached to the newly created com.rti.dds.subscription.Subscriber. |
mask | <<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask. |
void delete_subscriber | ( | Subscriber | s | ) |
Deletes an existing com.rti.dds.subscription.Subscriber.
s | <<in>> com.rti.dds.subscription.Subscriber to be deleted. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET. |
DataWriter create_datawriter | ( | Topic | topic, |
DataWriterQos | qos, | ||
DataWriterListener | listener, | ||
int | mask | ||
) |
<<extension>> Creates a com.rti.dds.publication.DataWriter that will be attached and belong to the implicit com.rti.dds.publication.Publisher.
The com.rti.dds.publication.DataWriter created using this method will be associated with the implicit Publisher. This Publisher is automatically created (if it does not exist) using com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT when the following methods are called: com.rti.dds.domain.DomainParticipant.create_datawriter, com.rti.dds.domain.DomainParticipant.create_datawriter_with_profile, or com.rti.dds.domain.DomainParticipant.get_implicit_publisher.
qos
parameter, it is not safe to create the DataWriter while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos. DataWriter create_datawriter_with_profile | ( | Topic | topic, |
String | library_name, | ||
String | profile_name, | ||
DataWriterListener | listener, | ||
int | mask | ||
) |
<<extension>> Creates a com.rti.dds.publication.DataWriter using a XML QoS profile that will be attached and belong to the implicit com.rti.dds.publication.Publisher.
The com.rti.dds.publication.DataWriter created using this method will be associated with the implicit Publisher. This Publisher is automatically created (if it does not exist) using com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT when the following methods are called: com.rti.dds.domain.DomainParticipant.create_datawriter, com.rti.dds.domain.DomainParticipant.create_datawriter_with_profile, or com.rti.dds.domain.DomainParticipant.get_implicit_publisher
topic | <<in>> The com.rti.dds.topic.Topic that the com.rti.dds.publication.DataWriter will be associated with. 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 com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
listener | <<in>> The listener of the com.rti.dds.publication.DataWriter. |
mask | <<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask. |
void delete_datawriter | ( | DataWriter | a_datawriter | ) |
<<extension>> Deletes a com.rti.dds.publication.DataWriter that belongs to the implicit com.rti.dds.publication.Publisher.
The deletion of the com.rti.dds.publication.DataWriter will automatically unregister all instances.
a_datawriter | <<in>> The com.rti.dds.publication.DataWriter to be deleted. |
One | of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET. |
DataReader create_datareader | ( | TopicDescription | topic, |
DataReaderQos | qos, | ||
DataReaderListener | listener, | ||
int | mask | ||
) |
<<extension>> Creates a com.rti.dds.subscription.DataReader that will be attached and belong to the implicit com.rti.dds.subscription.Subscriber.
The com.rti.dds.subscription.DataReader created using this method will be associated with the implicit Subscriber. This Subscriber is automatically created (if it does not exist) using com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT when the following methods are called: com.rti.dds.domain.DomainParticipant.create_datareader, com.rti.dds.domain.DomainParticipant.create_datareader_with_profile, or com.rti.dds.domain.DomainParticipant.get_implicit_subscriber.
qos
parameter, it is not safe to create the datareader while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datareader_qos. DataReader create_datareader_with_profile | ( | TopicDescription | topic, |
String | library_name, | ||
String | profile_name, | ||
DataReaderListener | listener, | ||
int | mask | ||
) |
<<extension>> Creates a com.rti.dds.subscription.DataReader using a XML QoS profile that will be attached and belong to the implicit com.rti.dds.subscription.Subscriber.
The com.rti.dds.subscription.DataReader created using this method will be associated with the implicit Subscriber. This Subscriber is automatically created (if it does not exist) using com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT when the following methods are called: com.rti.dds.domain.DomainParticipant.create_datareader, com.rti.dds.domain.DomainParticipant.create_datareader_with_profile, or com.rti.dds.domain.DomainParticipant.get_implicit_subscriber
topic | <<in>> The com.rti.dds.topic.TopicDescription that the com.rti.dds.subscription.DataReader will be associated with. 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 com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
listener | <<in>> The listener of the com.rti.dds.subscription.DataReader. |
mask | <<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask. |
void delete_datareader | ( | DataReader | a_datareader | ) |
<<extension>> Deletes a com.rti.dds.subscription.DataReader that belongs to the implicit com.rti.dds.subscription.Subscriber.
a_datareader | <<in>> The com.rti.dds.subscription.DataReader to be deleted. |
One | of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET. |
Topic create_topic | ( | String | topic_name, |
String | type_name, | ||
TopicQos | qos, | ||
TopicListener | listener, | ||
int | mask | ||
) |
Creates a com.rti.dds.topic.Topic with the desired QoS policies and attaches to it the specified com.rti.dds.topic.TopicListener.
topic_name
attached to the same com.rti.dds.domain.DomainParticipant. If the application attempts this, this method will fail and return a NULL topic. qos
, it is not safe to create the topic while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_topic_qos. topic_name | <<in>> Name for the new topic, must not exceed 255 characters. Cannot be NULL. |
type_name | <<in>> The type to which the new com.rti.dds.topic.Topic will be bound. Cannot be NULL. |
qos | <<in>> QoS to be used for creating the new com.rti.dds.topic.Topic. The special value com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT can be used to indicate that the com.rti.dds.topic.Topic should be created with the default com.rti.dds.topic.TopicQos set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL. |
listener | <<in>>. Listener to be attached to the newly created com.rti.dds.topic.Topic. |
mask | <<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask. |
Topic create_topic_with_profile | ( | String | topic_name, |
String | type_name, | ||
String | library_name, | ||
String | profile_name, | ||
TopicListener | listener, | ||
int | mask | ||
) |
<<extension>> Creates a new com.rti.dds.topic.Topic object using the com.rti.dds.publication.PublisherQos associated with the input XML QoS profile.
topic_name
attached to the same com.rti.dds.domain.DomainParticipant. If the application attempts this, this method will fail and return a NULL topic. topic_name | <<in>> Name for the new topic, must not exceed 255 characters. Cannot be NULL. |
type_name | <<in>> The type to which the new com.rti.dds.topic.Topic will be bound. 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 com.rti.dds.domain.DomainParticipant.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile). |
listener | <<in>>. Listener to be attached to the newly created com.rti.dds.topic.Topic. |
mask | <<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask. |
void delete_topic | ( | Topic | topic | ) |
Deletes a com.rti.dds.topic.Topic.
topic | <<in>> com.rti.dds.topic.Topic to be deleted. |
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET |
ContentFilteredTopic create_contentfilteredtopic | ( | String | name, |
Topic | related_topic, | ||
String | filter_expression, | ||
StringSeq | expression_parameters | ||
) |
Creates a com.rti.dds.topic.ContentFilteredTopic, that can be used to do content-based subscriptions.
The com.rti.dds.topic.ContentFilteredTopic only relates to samples published under that com.rti.dds.topic.Topic, filtered according to their content. The filtering is done by means of evaluating a logical expression that involves the values of some of the data-fields in the sample. The logical expression derived from the filter_expression
and expression_parameters
arguments.
Queries and Filters Syntax describes the syntax of filter_expression
and expression_parameters
.
topic_name
attached to the same com.rti.dds.domain.DomainParticipant. If the application attempts this, this method will fail and returns NULL. related_topic
does not belong to this com.rti.dds.domain.DomainParticipant, this operation returns NULL. name | <<in>> Name for the new content filtered topic, must not exceed 255 characters. Cannot be NULL. |
related_topic | <<in>> com.rti.dds.topic.Topic to be filtered. Cannot be NULL. |
filter_expression | <<in>> Cannot be NULL |
expression_parameters | <<in>> Cannot be NULL. An empty sequence must be used if the filter expression does not contain any parameters. Length of sequence cannot be greater than 100. |
ContentFilteredTopic create_contentfilteredtopic_with_filter | ( | String | name, |
Topic | related_topic, | ||
String | filter_expression, | ||
StringSeq | expression_parameters, | ||
String | filter_name | ||
) |
<<extension>> Creates a com.rti.dds.topic.ContentFilteredTopic using the specified filter to do content-based subscriptions.
name | <<in>> Name for the new content filtered topic. Cannot exceed 255 characters. Cannot be NULL. |
related_topic | <<in>> com.rti.dds.topic.Topic to be filtered. Cannot be NULL. |
filter_expression | <<in>> Cannot be NULL. |
expression_parameters | <<in>> Cannot be NULL. . An empty sequence must be used if the filter expression does not contain any parameters. Length of the sequence cannot be greater than 100. |
filter_name | <<in>> Name of content filter to use. Must previously have been registered with com.rti.dds.domain.DomainParticipant.register_contentfilter on the same com.rti.dds.domain.DomainParticipant. Cannot be NULL. Builtin filter names are com.rti.dds.domain.DomainParticipant.SQLFILTER_NAME and com.rti.dds.domain.DomainParticipant.STRINGMATCHFILTER_NAME |
void delete_contentfilteredtopic | ( | ContentFilteredTopic | a_contentfilteredtopic | ) |
Deletes a com.rti.dds.topic.ContentFilteredTopic.
a_contentfilteredtopic | <<in>> |
One | of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET |
MultiTopic create_multitopic | ( | String | name, |
String | type_name, | ||
String | subscription_expression, | ||
StringSeq | expression_parameters | ||
) |
[Not supported (optional)] Creates a MultiTopic that can be used to subscribe to multiple topics and combine/filter the received data into a resulting type.
The resulting type is specified by the type_name
argument. The list of topics and the logic used to combine, filter, and rearrange the information from each com.rti.dds.topic.Topic are specified using the subscription_expression
and expression_parameters
arguments.
Queries and Filters Syntax describes the syntax of subscription_expression
and expression_parameters
.
name
attached to the same com.rti.dds.domain.DomainParticipant. If the application attempts this, this method will fail and return NULL. name | <<in>> Name of the newly create com.rti.dds.topic.MultiTopic. Cannot be NULL. |
type_name | <<in>> Cannot be NULL. |
subscription_expression | <<in>> Cannot be NULL. |
expression_parameters | <<in>> Cannot be NULL. |
void delete_multitopic | ( | MultiTopic | a_multitopic | ) |
[Not supported (optional)] Deletes a com.rti.dds.topic.MultiTopic.
a_multitopic | <<in>> |
void set_qos | ( | DomainParticipantQos | qos | ) |
Change the QoS of this DomainParticipant.
The com.rti.dds.domain.DomainParticipantQos.user_data and com.rti.dds.domain.DomainParticipantQos.entity_factory can be changed. The other policies are immutable.
qos | <<in>> Set of policies to be applied to com.rti.dds.domain.DomainParticipant. Policies must be consistent. Immutable policies cannot be changed after com.rti.dds.domain.DomainParticipant is enabled. The special value com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT_QOS_DEFAULT can be used to indicate that the QoS of the com.rti.dds.domain.DomainParticipant should be changed to match the current default com.rti.dds.domain.DomainParticipantQos set in the com.rti.dds.domain.DomainParticipantFactory. Cannot be NULL. |
One | of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_IMMUTABLE_POLICY if an immutable policy is changed, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY if policies are inconsistent |
void set_qos_with_profile | ( | String | library_name, |
String | profile_name | ||
) |
<<extension>> Change the QoS of this domain participant using the input XML QoS profile.
The com.rti.dds.domain.DomainParticipantQos.user_data and com.rti.dds.domain.DomainParticipantQos.entity_factory can be changed. The other policies are immutable.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipantFactory.set_default_library). |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipantFactory.set_default_profile). |
One | of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_IMMUTABLE_POLICY if immutable policy is changed, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY if policies are inconsistent |
void get_qos | ( | DomainParticipantQos | qos | ) |
Get the participant QoS.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<inout>> QoS to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
String get_default_library | ( | ) |
<<extension>> Gets the default XML library associated with a com.rti.dds.domain.DomainParticipant.
void set_default_library | ( | String | library_name | ) |
<<extension>> Sets the default XML library for a com.rti.dds.domain.DomainParticipant.
This method specifies the library that will be used as the default the next time a default library is needed during a call to one of this DomainParticipant's operations.
Any API requiring a library_name as a parameter can use null to refer to the default library.
If the default library is not set, the com.rti.dds.domain.DomainParticipant inherits the default from the com.rti.dds.domain.DomainParticipantFactory (see com.rti.dds.domain.DomainParticipantFactory.set_default_library).
library_name | <<in>> Library name. If library_name is null any previous default is unset. |
One | of the Standard Return Codes |
String get_default_profile | ( | ) |
<<extension>> Gets the default XML profile associated with a com.rti.dds.domain.DomainParticipant.
void set_default_profile | ( | String | library_name, |
String | profile_name | ||
) |
<<extension>> Sets the default XML profile for a com.rti.dds.domain.DomainParticipant.
This method specifies the profile that will be used as the default the next time a default DomainParticipant profile is needed during a call to one of this DomainParticipant's operations. When calling a com.rti.dds.domain.DomainParticipant 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.)
If the default profile is not set, the com.rti.dds.domain.DomainParticipant inherits the default from the com.rti.dds.domain.DomainParticipantFactory (see com.rti.dds.domain.DomainParticipantFactory.set_default_profile).
This method does not set the default QoS for entities created by the com.rti.dds.domain.DomainParticipant; for this functionality, use the methods set_default_<entity>_qos_with_profile (you may pass in NULL after having called set_default_profile()).
This method does not set the default QoS for newly created DomainParticipants; for this functionality, use com.rti.dds.domain.DomainParticipantFactory.set_default_participant_qos_with_profile.
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. |
One | of the Standard Return Codes |
String get_default_profile_library | ( | ) |
<<extension>> Gets the library where the default XML QoS profile is contained for a com.rti.dds.domain.DomainParticipant.
The default profile library is automatically set when com.rti.dds.domain.DomainParticipant.set_default_profile is called.
This library can be different than the com.rti.dds.domain.DomainParticipant default library (see com.rti.dds.domain.DomainParticipant.get_default_library).
void set_listener | ( | DomainParticipantListener | l, |
int | mask | ||
) |
Sets the participant listener.
l | <<in>> Listener to be installed on the entity. |
mask | <<in>> Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask. |
One | of the Standard Return Codes |
DomainParticipantListener get_listener | ( | ) |
Get the participant listener.
void get_publishers | ( | PublisherSeq | publishers | ) |
<<extension>> Allows the application to access all the publishers the participant has.
If the sequence doesn't own its buffer, and its maximum is less than the total number of publishers, it will be filled up to its maximum, and fail with com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES.
publishers | <<inout>> a PublisherSeq object where the set or list of publishers will be returned |
One | of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES |
void get_subscribers | ( | SubscriberSeq | subscribers | ) |
<<extension>> Allows the application to access all the subscribers the participant has.
If the sequence doesn't own its buffer, and its maximum is less than the total number of subscribers, it will be filled up to its maximum, and fail with com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES.
subscribers | <<inout>> a SubscriberSeq object where the set or list of subscribers will be returned |
One | of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES |
Subscriber get_builtin_subscriber | ( | ) |
Accesses the built-in com.rti.dds.subscription.Subscriber.
Each com.rti.dds.domain.DomainParticipant contains several built-in com.rti.dds.topic.Topic objects as well as corresponding com.rti.dds.subscription.DataReader objects to access them. All of these com.rti.dds.subscription.DataReader objects belong to a single built-in com.rti.dds.subscription.Subscriber.
The built-in Topics are used to communicate information about other com.rti.dds.domain.DomainParticipant, com.rti.dds.topic.Topic, com.rti.dds.subscription.DataReader, and com.rti.dds.publication.DataWriter objects.
The built-in subscriber is created when this operation is called for the first time. The built-in subscriber is deleted automatically when the com.rti.dds.domain.DomainParticipant is deleted.
FlowController lookup_flowcontroller | ( | String | name | ) |
<<extension>> Looks up an existing locally-created com.rti.dds.publication.FlowController, based on its name.
Looks up a previously created com.rti.dds.publication.FlowController, including the built-in ones. Once a com.rti.dds.publication.FlowController has been deleted, subsequent lookups will fail.
name | <<in>> Name of com.rti.dds.publication.FlowController to search for. Limited to 255 characters. Cannot be NULL. |
Topic find_topic | ( | String | topic_name, |
Duration_t | timeout | ||
) |
Finds an existing (or ready to exist) com.rti.dds.topic.Topic, based on its name.
This call can be used to block for a specified duration to wait for the com.rti.dds.topic.Topic to be created.
If the requested com.rti.dds.topic.Topic already exists, it is returned. Otherwise, find_topic() waits until another thread creates it or else returns when the specified timeout occurs.
find_topic() is useful when multiple threads are concurrently creating and looking up topics. In that case, one thread can call find_topic() and, if another thread has not yet created the topic being looked up, it can wait for some period of time for it to do so. In almost all other cases, it is more straightforward to call com.rti.dds.domain.DomainParticipant.lookup_topicdescription.
The com.rti.dds.domain.DomainParticipant must already be enabled.
Note: Each com.rti.dds.topic.Topic obtained by com.rti.dds.domain.DomainParticipant.find_topic must also be deleted by means of com.rti.dds.domain.DomainParticipant.delete_topic. If com.rti.dds.topic.Topic is obtained multiple times by means of com.rti.dds.domain.DomainParticipant.find_topic or com.rti.dds.domain.DomainParticipant.create_topic, it must also be deleted that same number of times using com.rti.dds.domain.DomainParticipant.delete_topic.
topic_name | <<in>> Name of the com.rti.dds.topic.Topic to search for. Cannot be NULL. |
timeout | <<in>> The time to wait if the com.rti.dds.topic.Topic does not exist already. Cannot be NULL. |
TopicDescription lookup_topicdescription | ( | String | topic_name | ) |
Looks up an existing, locally created com.rti.dds.topic.TopicDescription, based on its name.
com.rti.dds.topic.TopicDescription is the base class for com.rti.dds.topic.Topic, com.rti.dds.topic.MultiTopic and com.rti.dds.topic.ContentFilteredTopic. So you can narrow the com.rti.dds.topic.TopicDescription returned from this operation to a com.rti.dds.topic.Topic or com.rti.dds.topic.ContentFilteredTopic as appropriate.
Unlike com.rti.dds.domain.DomainParticipant.find_topic, which logically returns a new com.rti.dds.topic.Topic object that must be independently deleted, this operation returns a reference to the original local object.
The com.rti.dds.domain.DomainParticipant does not have to be enabled when you call lookup_topicdescription().
The returned topic may be either enabled or disabled.
topic_name | <<in>> Name of com.rti.dds.topic.TopicDescription to search for. This string must be no more than 255 characters; it cannot be NULL. |
void ignore_participant | ( | InstanceHandle_t | handle | ) |
Instructs RTI Connext to locally ignore a remote com.rti.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 com.rti.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 com.rti.dds.domain.builtin.ParticipantBuiltinTopicData to provide access control.
Application data can be associated with a com.rti.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 com.rti.dds.domain.DomainParticipant to ignore is identified by the handle argument. This
handle
is the one that appears in the com.rti.dds.subscription.SampleInfo retrieved when reading the data-samples available for the built-in com.rti.dds.subscription.DataReader to the com.rti.dds.domain.DomainParticipant topic. The built-in com.rti.dds.subscription.DataReader is read with the same com.rti.ndds.example.FooDataReader.read and com.rti.ndds.example.FooDataReader.take operations used for any com.rti.dds.subscription.DataReader.
handle | <<in>> com.rti.dds.infrastructure.InstanceHandle_t of the com.rti.dds.domain.DomainParticipant to be ignored. Cannot be NULL. |
void banish_ignored_participants | ( | ) |
<<extension>> Prevents ignored remote DomainParticipants from receiving traffic from the local com.rti.dds.domain.DomainParticipant.
This method complements com.rti.dds.domain.DomainParticipant.ignore_participant: ignore_participant prevents the local com.rti.dds.domain.DomainParticipant from processing traffic from the remote DomainParticipant, while this method prevents already ignored remote DomainParticipants from processing traffic from the local DomainParticipant.
Note: this method is currently only supported when enabling the RTI Security Plugins. Please refer to the RTI Security Plugins User's Manual for more information.
void ignore_topic | ( | InstanceHandle_t | handle | ) |
Instructs RTI Connext to locally ignore a com.rti.dds.topic.Topic.
This means it will locally ignore any publication, or subscription to the com.rti.dds.topic.Topic.
There is no way to reverse this operation.
This operation can be used to save local resources when the application knows that it will never publish or subscribe to data under certain topics.
The com.rti.dds.topic.Topic to ignore is identified by the handle
argument. This is the handle of a com.rti.dds.topic.Topic that appears in the com.rti.dds.subscription.SampleInfo retrieved when reading data samples from the built-in com.rti.dds.subscription.DataReader for the com.rti.dds.topic.Topic.
handle | <<in>> Handle of the com.rti.dds.topic.Topic to be ignored. Cannot be NULL. |
One | of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED |
void ignore_publication | ( | InstanceHandle_t | handle | ) |
Instructs RTI Connext to locally ignore a publication.
A publication is defined by the association of a topic name, user data, and partition set on the com.rti.dds.publication.Publisher (see com.rti.dds.publication.builtin.PublicationBuiltinTopicData). After this call, any data written by that publication's com.rti.dds.publication.DataWriter will be ignored.
This operation can be used to ignore local and remote DataWriters.
The publication (DataWriter) to ignore is identified by the handle
argument.
handle
can be obtained from the com.rti.dds.subscription.SampleInfo retrieved when reading data samples from the built-in com.rti.dds.subscription.DataReader for the com.rti.dds.publication topic. handle
can be obtained by calling com.rti.dds.infrastructure.Entity.get_instance_handle for the local DataWriter. There is no way to reverse this operation.
handle | <<in>> Handle of the com.rti.dds.publication.DataWriter to be ignored. Cannot be NULL. |
void ignore_subscription | ( | InstanceHandle_t | handle | ) |
Instructs RTI Connext to locally ignore a subscription.
A subscription is defined by the association of a topic name, user data, and partition set on the com.rti.dds.subscription.Subscriber (see com.rti.dds.subscription.builtin.SubscriptionBuiltinTopicData). After this call, any data received related to that subscription's com.rti.dds.subscription.DataReader will be ignored.
This operation can be used to ignore local and remote DataReaders.
The subscription to ignore is identified by the handle
argument.
handle
can be obtained from the com.rti.dds.subscription.SampleInfo retrieved when reading data samples from the built-in com.rti.dds.subscription.DataReader for the com.rti.dds.subscription topic. handle
can be obtained by calling com.rti.dds.infrastructure.Entity.get_instance_handle for the local DataReader. There is no way to reverse this operation.
handle | <<in>> Handle of the com.rti.dds.subscription.DataReader to be ignored. Cannot be NULL. |
int get_domain_id | ( | ) |
Get the unique domain identifier.
This operation retrieves the domain id used to create the com.rti.dds.domain.DomainParticipant. The domain id identifies the DDS domain to which the com.rti.dds.domain.DomainParticipant belongs. Each DDS domain represents a separate data 'communication plane' isolated from other domains.
domainId
that was used to create the domain void assert_liveliness | ( | ) |
Manually asserts the liveliness of this com.rti.dds.domain.DomainParticipant.
This is used in combination with the com.rti.dds.infrastructure.LivelinessQosPolicy to indicate to RTI Connext that the entity remains active.
You need to use this operation if the com.rti.dds.domain.DomainParticipant contains com.rti.dds.publication.DataWriter entities with the com.rti.dds.infrastructure.LivelinessQosPolicy.kind set to com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANUAL_BY_PARTICIPANT_LIVELINESS_QOS and it only affects the liveliness of those com.rti.dds.publication.DataWriter entities. Otherwise, it has no effect.
Note: writing data via the com.rti.ndds.example.FooDataWriter.write or com.rti.ndds.example.FooDataWriter.write_w_timestamp operation asserts liveliness on the com.rti.dds.publication.DataWriter itself and its com.rti.dds.domain.DomainParticipant. Consequently the use of assert_liveliness() is only needed if the application is not writing data regularly.
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED |
void delete_contained_entities | ( | ) |
Delete all the entities that were created by means of the "create" operations on the com.rti.dds.domain.DomainParticipant.
This operation deletes all contained com.rti.dds.publication.Publisher (including an implicit Publisher, if one exists), com.rti.dds.subscription.Subscriber (including implicit Subscriber), com.rti.dds.topic.Topic, com.rti.dds.topic.ContentFilteredTopic, and com.rti.dds.topic.MultiTopic objects.
Prior to deleting each contained entity, this operation will recursively call the corresponding delete_contained_entities()
operation on each contained entity (if applicable). This pattern is applied recursively. In this manner the operation delete_contained_entities()
on the com.rti.dds.domain.DomainParticipant will end up recursively deleting all the entities contained in the com.rti.dds.domain.DomainParticipant, including the com.rti.dds.publication.DataWriter, com.rti.dds.subscription.DataReader, as well as the com.rti.dds.subscription.QueryCondition, com.rti.dds.subscription.ReadCondition, and com.rti.dds.subscription.TopicQuery objects belonging to the contained com.rti.dds.subscription.DataReader.
The operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET if any of the contained entities is in a state where it cannot be deleted .
If delete_contained_entities() completes successfully, the application may delete the com.rti.dds.domain.DomainParticipant.
One | of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET. |
void add_peer | ( | String | peer_desc_string | ) |
<<extension>> Attempt to contact one or more additional peer participants.
Add the given peer description to the list of peers with which this com.rti.dds.domain.DomainParticipant will try to communicate.
This method may be called at any time after this com.rti.dds.domain.DomainParticipant has been created (before or after it has been enabled).
If this method is called after com.rti.dds.infrastructure.Entity.enable, an attempt will be made to contact the new peer(s) immediately.
If this method is called before the DomainParticipant is enabled, the peer description will simply be added to the list that was populated by com.rti.dds.infrastructure.DiscoveryQosPolicy.initial_peers; the first attempted contact will take place after this com.rti.dds.domain.DomainParticipant is enabled.
Adding a peer description with this method does not guarantee that any peer(s) discovered as a result will exactly correspond to those described:
To be informed of the exact remote participants that are discovered, regardless of which peers this com.rti.dds.domain.DomainParticipant attempts to discover, use the built-in participant topic: com.rti.dds.domain.builtin.ParticipantBuiltinTopicDataTypeSupport.PARTICIPANT_TOPIC_NAME.
To remove specific peer locators, you may use com.rti.dds.domain.DomainParticipant.remove_peer. If a peer is removed, the add_peer operation will add it back to the list of peers.
To stop communicating with a peer com.rti.dds.domain.DomainParticipant that has been discovered, use com.rti.dds.domain.DomainParticipant.ignore_participant.
Adding a peer description with this method has no effect on the com.rti.dds.infrastructure.DiscoveryQosPolicy.initial_peers that may be subsequently retrieved with com.rti.dds.domain.DomainParticipant.get_qos() (because com.rti.dds.infrastructure.DiscoveryQosPolicy is immutable).
peer_desc_string | <<in>> New peer descriptor to be added. The format is specified in Peer Descriptor Format. Cannot be NULL. |
One | of the Standard Return Codes |
void remove_peer | ( | String | peer_desc_string | ) |
<<extension>> Remove one or more peer participants from the list of peers with which this com.rti.dds.domain.DomainParticipant will try to communicate.
This method may be called any time after this com.rti.dds.domain.DomainParticipant has been enabled
Calling this method has the following effects:
If remote participants located on a peer that was previously removed are discovered, they will be ignored untill the related peer is added back by using com.rti.dds.domain.DomainParticipant.add_peer.
Removing a peer description with this method has no effect on the com.rti.dds.infrastructure.DiscoveryQosPolicy.initial_peers that may be subsequently retrieved with com.rti.dds.domain.DomainParticipant.get_qos() (because com.rti.dds.infrastructure.DiscoveryQosPolicy is immutable).
peer_desc_string | <<in>> Peer descriptor to be removed. The format is specified in Peer Descriptor Format. Cannot be NULL. |
One | of the Standard Return Codes |
void get_dns_tracker_polling_period | ( | Duration_t | polling_period | ) |
<<extension>> Retrieves the frequency used by the DNS tracker thread to query the DNS service.
The DNS tracker queries the DNS for hostnames specified in the initial peers of a DomainParticipant. The frequency of these queries is defined by com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.dns_tracker_polling_period. If the value returned is com.rti.dds.infrastructure.Duration_t.DURATION_INFINITE, the DNS tracker is disabled.
polling_period | <<out>> Duration that the API populates with the period of the DNS tracker. |
One | of the Standard Return Codes |
void set_dns_tracker_polling_period | ( | Duration_t | polling_period | ) |
<<extension>> Configures the frequency in which the DNS tracker queries the DNS service.
This API allows you to change the frequency of the polling period for the DNS tracker. The range of accepted values, in seconds, goes from 1 second to 1 year. com.rti.dds.infrastructure.Duration_t.DURATION_INFINITE is also accepted as a valid value. If the duration is set to com.rti.dds.infrastructure.Duration_t.DURATION_INFINITE, the DNS tracker is disabled.
Modifying the DNS tracker polling period through this has no effect on the com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.dns_tracker_polling_period when it is retrieved with com.rti.dds.domain.DomainParticipant.get_qos().
polling_period | <<in>> Duration that is set as the polling period for the DNS tracker. |
One | of the Standard Return Codes |
void get_current_time | ( | Time_t | current_time | ) |
Returns the current value of the time.
The current value of the time that RTI Connext uses to time-stamp com.rti.dds.publication.DataWriter and to set the reception-timestamp for the data updates that it receives.
current_time | <<inout>> Current time to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void get_discovered_participants | ( | InstanceHandleSeq | participant_handles | ) |
Returns a list of discovered com.rti.dds.domain.DomainParticipant entities.
This operation retrieves the list of com.rti.dds.domain.DomainParticipant entities that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_participant operation. When using com.rti.dds.infrastructure.DiscoveryConfigBuiltinPluginKind.SPDP2, this list only includes com.rti.dds.domain.DomainParticipant entities that the application has received configuration information from.
participant_handles | <<inout>> com.rti.dds.infrastructure.InstanceHandleSeq to be filled with handles of the discovered com.rti.dds.domain.DomainParticipant entities. |
One | of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED |
void get_discovered_participants_from_subject_name | ( | InstanceHandleSeq | participant_handles, |
String | subject_name | ||
) |
<<extension>> Returns a list of discovered com.rti.dds.domain.DomainParticipant entities that have the given com.rti.dds.infrastructure.EntityNameQosPolicy.name.
This operation retrieves the same list as com.rti.dds.domain.DomainParticipant.get_discovered_participants, except this list contains only the participants that have the given com.rti.dds.infrastructure.EntityNameQosPolicy.name.
Note: this method has different functionality when enabling the RTI Security Plugins. Please refer to the RTI Security Plugins User's Manual for more information.
participant_handles | <<inout>> com.rti.dds.infrastructure.InstanceHandleSeq to be filled with handles of the discovered com.rti.dds.domain.DomainParticipant entities. |
subject_name | <<in>> The com.rti.dds.infrastructure.EntityNameQosPolicy.name by which to filter the list. |
One | of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED |
void get_discovered_participant_data | ( | ParticipantBuiltinTopicData | participant_data, |
InstanceHandle_t | participant_handle | ||
) |
Returns com.rti.dds.domain.builtin.ParticipantBuiltinTopicData for the specified com.rti.dds.domain.DomainParticipant.
This operation retrieves information on a com.rti.dds.domain.DomainParticipant that has been discovered on the network. The participant must be in the same domain as the participant on which this operation is invoked and must not have been "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_participant operation.
The participant_handle
must correspond to such a DomainParticipant. Otherwise, the operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.
Use the operation com.rti.dds.domain.DomainParticipant.get_discovered_participants to find the com.rti.dds.domain.DomainParticipant entities that are currently discovered.
participant_data | <<inout>> com.rti.dds.domain.builtin.ParticipantBuiltinTopicData to be filled in with the data for the specified com.rti.dds.domain.DomainParticipant. |
participant_handle | <<in>> com.rti.dds.infrastructure.InstanceHandle_t of com.rti.dds.domain.DomainParticipant. |
String get_discovered_participant_subject_name | ( | InstanceHandle_t | participant_handle | ) |
<<extension>> Returns com.rti.dds.infrastructure.EntityNameQosPolicy.name for the specified com.rti.dds.domain.DomainParticipant.
This operation retrieves the com.rti.dds.infrastructure.EntityNameQosPolicy.name of a com.rti.dds.domain.DomainParticipant that has been discovered on the network. The participant must be in the same domain as the participant on which this operation is invoked and must not have been "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_participant operation.
The participant_handle
must correspond to such a DomainParticipant. If the participant_handle
is com.rti.dds.infrastructure.InstanceHandle_t.HANDLE_NIL or is not a valid com.rti.dds.infrastructure.InstanceHandle_t for a DomainParticipant, then the operation will fail with com.rti.dds.infrastructure.RETCODE_BAD_PARAMETER. If the participant_handle
corresponds to a DomainParticipant that has not been discovered, then the operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.
Use the operation com.rti.dds.domain.DomainParticipant.get_discovered_participants to find the com.rti.dds.domain.DomainParticipant entities that are currently discovered.
Note: this method has different functionality when enabling the RTI Security Plugins. Please refer to the RTI Security Plugins User's Manual for more information.
participant_handle | <<in>> com.rti.dds.infrastructure.InstanceHandle_t of com.rti.dds.domain.DomainParticipant. |
participant_handle
void get_discovered_topics | ( | InstanceHandleSeq | topic_handles | ) |
Returns list of discovered com.rti.dds.topic.Topic objects.
This operation retrieves the list of com.rti.dds.topic.Topic s that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_topic operation.
topic_handles | <<inout>> com.rti.dds.infrastructure.InstanceHandleSeq to be filled with handles of the discovered com.rti.dds.topic.Topic objects |
One | of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED |
void get_discovered_topic_data | ( | TopicBuiltinTopicData | topic_data, |
InstanceHandle_t | topic_handle | ||
) |
Returns builtin.TopicBuiltinTopicData for the specified com.rti.dds.topic.Topic.
This operation retrieves information on a com.rti.dds.topic.Topic that has been discovered by the local Participant and must not have been "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_topic operation.
The topic_handle
must correspond to such a topic. Otherwise, the operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.
This call is not supported for remote topics. If a remote topic_handle
is used, the operation will fail with com.rti.dds.infrastructure.RETCODE_UNSUPPORTED.
Use the operation com.rti.dds.domain.DomainParticipant.get_discovered_topics to find the topics that are currently discovered.
topic_data | <<inout>> builtin.TopicBuiltinTopicData to be filled with the specified com.rti.dds.topic.Topic's data. |
topic_handle | <<in>> com.rti.dds.infrastructure.InstanceHandle_t of com.rti.dds.topic.Topic. |
One | of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED |
boolean contains_entity | ( | InstanceHandle_t | a_handle | ) |
Completes successfully with com.rti.dds.infrastructure.true if the referenced com.rti.dds.infrastructure.Entity is contained by the com.rti.dds.domain.DomainParticipant.
This operation checks whether or not the given a_handle
represents an com.rti.dds.infrastructure.Entity that was created from the com.rti.dds.domain.DomainParticipant. The containment applies recursively. That is, it applies both to entities (com.rti.dds.topic.TopicDescription, com.rti.dds.publication.Publisher, or com.rti.dds.subscription.Subscriber) created directly using the com.rti.dds.domain.DomainParticipant as well as entities created using a contained com.rti.dds.publication.Publisher, or com.rti.dds.subscription.Subscriber as the factory, and so forth.
The instance
handle for an com.rti.dds.infrastructure.Entity may be obtained from built-in topic data, from various statuses, or from the operation com.rti.dds.infrastructure.Entity.get_instance_handle.
a_handle | <<in>> com.rti.dds.infrastructure.InstanceHandle_t of the com.rti.dds.infrastructure.Entity to be checked. |
void register_durable_subscription | ( | EndpointGroup_t | group, |
String | topic_name | ||
) |
<<extension>> Registers a Durable Subscription on the specified com.rti.dds.topic.Topic on all Persistence Services.
If you need to receive all samples published on a com.rti.dds.topic.Topic, including the ones published while a com.rti.dds.subscription.DataReader is inactive or before it may be created, create a Durable Subscription using this method.
In this way, the Persistence Service will ensure that all the samples on that com.rti.dds.topic.Topic are retained until they are acknowledged by at least N DataReaders belonging to the Durable Subscription where N is the quorum count.
If the same Durable Subscription is created on a different com.rti.dds.topic.Topic, the Persistence Service will implicitly delete the previous Durable Subscription and create a new one on the new com.rti.dds.topic.Topic.
group | <<in>> com.rti.dds.infrastructure.EndpointGroup_t The Durable Subscription name and quorum. |
topic_name | <<in>> The topic name for which the Durable Subscription is created. |
One | of the Standard Return Codes |
void delete_durable_subscription | ( | EndpointGroup_t | group | ) |
<<extension>> Deletes an existing Durable Subscription on all Persistence Services.
The Persistence Service will delete the Durable Subscription and the quorum of the existing samples will be considered satisfied.
group | <<in>> com.rti.dds.infrastructure.EndpointGroup_t specifying the Durable Subscription name. Quorum is not required for this operation. |
One | of the Standard Return Codes |
void resume_endpoint_discovery | ( | InstanceHandle_t | remote_participant_handle | ) |
<<extension>> Initiates endpoint discovery with the specified remote com.rti.dds.domain.DomainParticipant.
If the operation returns com.rti.dds.infrastructure.RETCODE_OK, the com.rti.dds.domain.DomainParticipant will initiate endpoint discovery with the remote com.rti.dds.domain.DomainParticipant provided as a parameter.
When com.rti.dds.infrastructure.DiscoveryQosPolicy.enable_endpoint_discovery is set to com.rti.dds.infrastructure.false, this operation allows the RTI Connext application to select for which remote DomainParticipants endpoint discovery is performed. By disabling endpoint discovery, the DomainParticipant will not store any state about remote endpoints and will not send local endpoint information to remote DomainParticipants.
If com.rti.dds.infrastructure.DiscoveryQosPolicy.enable_endpoint_discovery is set to com.rti.dds.infrastructure.true, endpoint discovery will automatically occur for every discovered com.rti.dds.domain.DomainParticipant. In this case, invoking this operation will have no effect and will return com.rti.dds.infrastructure.RETCODE_OK.
When com.rti.dds.infrastructure.DiscoveryQosPolicy.enable_endpoint_discovery is set to com.rti.dds.infrastructure.false, you have two options after a remote com.rti.dds.domain.DomainParticipant is discovered:
Setting com.rti.dds.infrastructure.DiscoveryQosPolicy.enable_endpoint_discovery to com.rti.dds.infrastructure.false enables application-level authentication use cases, in which a com.rti.dds.domain.DomainParticipant will initiate endpoint discovery with a remote com.rti.dds.domain.DomainParticipant after successful authentication at the application level.
The remote_participant_handle
paremeter is the one that appears in the com.rti.dds.subscription.SampleInfo retrieved when reading the data samples available for the built-in builtin.ParticipantBuiltinTopicDataDataReader.
If the specified remote com.rti.dds.domain.DomainParticipant is not in the database of discovered DomainParticipants or has been previously ignored, this operation will fail with com.rti.dds.infrastructure.RETCODE_ERROR.
This operation can be called multiple times on the same remote participant. If endpoint discovery has already been resumed, successive calls will have no effect and will return com.rti.dds.infrastructure.RETCODE_OK.
remote_participant_handle | <<in>> Handle of a discovered com.rti.dds.domain.DomainParticipant for which endpoint discovery is to be resumed. Cannot be NULL. |
One | of the Standard Return Codes,or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED |
void register_contentfilter | ( | String | filter_name, |
ContentFilter | contentfilter | ||
) |
<<extension>> Register a content filter which can be used to create a com.rti.dds.topic.ContentFilteredTopic.
DDS specifies a SQL-like content filter for use by content filtered topics. If this filter does not meet your filtering requirements, you can register a custom filter.
To use a custom filter, it must be registered in the following places:
For example, suppose Application A on the subscription side creates a Topic named X and a ContentFilteredTopic named filteredX (and a corresponding DataReader), using a previously registered content filter, myFilter. With only that, you will have filtering at the subscription side. If you also want to perform filtering in any application that publishes Topic X, then you also need to register the same definition of the ContentFilter myFilter in that application.
Each filter_name
can only be used to registered a content filter once with a com.rti.dds.domain.DomainParticipant.
filter_name | <<in>> Name of the filter. The name must be unique within the com.rti.dds.domain.DomainParticipant and must not exceed 255 characters. Cannot be NULL. |
contentfilter | <<in>> Content filter to be registered. Cannot be NULL. |
One | of the Standard Return Codes |
ContentFilter lookup_contentfilter | ( | String | filter_name | ) |
<<extension>> Lookup a content filter previously registered with com.rti.dds.domain.DomainParticipant.register_contentfilter.
filter_name | <<in>> Name of the filter. Cannot be NULL. |
void unregister_contentfilter | ( | String | filter_name | ) |
<<extension>> Unregister a content filter previously registered with com.rti.dds.domain.DomainParticipant.register_contentfilter.
A filter_name
can be unregistered only if it has been previously registered to the com.rti.dds.domain.DomainParticipant with com.rti.dds.domain.DomainParticipant.register_contentfilter.
The unregistration of filter is not allowed if there are any existing com.rti.dds.topic.ContentFilteredTopic objects that are using the filter. If the operation is called on a filter with existing com.rti.dds.topic.ContentFilteredTopic objects attached to it, this operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.
If there are still existing discovered com.rti.dds.subscription.DataReader s with the same filter_name
and the filter's compile method of the filter have previously been called on the discovered com.rti.dds.subscription.DataReader s, finalize method of the filter will be called on those discovered com.rti.dds.subscription.DataReader s before the content filter is unregistered. This means filtering will now be performed on the application that is creating the com.rti.dds.subscription.DataReader.
filter_name | <<in>> Name of the filter. Cannot be NULL. |
One | of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET |
TypeCode get_typecode | ( | String | type_name | ) |
<<extension>> Retrieves the com.rti.dds.typecode.TypeCode of a type registered with the com.rti.dds.domain.DomainParticipant based on the registration name.
Every data type used in a com.rti.dds.domain.DomainParticipant has a registered type name which is the name specified at the time the type is registered with the com.rti.dds.domain.DomainParticipant.
This operation retrieves the com.rti.dds.typecode.TypeCode for the type given the registared type name. The type_name
argument must correspond to a name used to register a type with the com.rti.dds.domain.DomainParticipant. Otherwise, this method will return NULL.
Type registration in a com.rti.dds.domain.DomainParticipant is performed by a call to the com.rti.ndds.example.FooTypeSupport.register_type operation on a derived class of the com.rti.dds.topic.TypeSupport interface.
Type registration might occur directly via an application call to the com.rti.ndds.example.FooTypeSupport.register_type operation, or indirectly by the RTI Connext infrastructure as a result of parsing an XML configuration file that refers to that type.
If a type is registered by the RTI Connext infrastructure as a result of parsing an XML configuration file, the com.rti.dds.topic.TypeSupport can be created either from a type description found in the XML files, or else by calling the com.rti.ndds.example.FooTypeSupport.register_type operation on a com.rti.dds.topic.TypeSupport that has been registered with com.rti.dds.domain.DomainParticipantFactory. If a com.rti.dds.topic.TypeSupport is registered with the com.rti.dds.domain.DomainParticipantFactory this mechanism takes precedence over the creation of a com.rti.dds.topic.TypeSupport from a type decription in the XML file.
To register a com.rti.dds.topic.TypeSupport with the com.rti.dds.domain.DomainParticipantFactory use the operation com.rti.dds.domain.DomainParticipantFactory.register_type_support.
If the com.rti.dds.topic.TypeSupport is created from a type description found in the XML files, the resulting type support will be a com.rti.dds.dynamicdata.DynamicDataTypeSupport. In this case the com.rti.dds.publication.DataWriter and com.rti.dds.subscription.DataReader uses to write and read data of that type will be the com.rti.dds.dynamicdata.DynamicDataWriter and com.rti.dds.dynamicdata.DynamicDataReader, respectively.
type_name | <<in>> Name of the type whose TypeCode is retrieved. |
void get_participant_protocol_status | ( | DomainParticipantProtocolStatus | status | ) |
<<extension>> Get the domain participant protocol status for this participant.
This also resets the status so that it is no longer considered changed.
status | <<inout>> com.rti.dds.domain.DomainParticipantProtocolStatus to be filled in. Cannot be NULL. |
One | of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED. |
Publisher get_implicit_publisher | ( | ) |
<<extension>> Returns the implicit com.rti.dds.publication.Publisher. If an implicit Publisher does not already exist, this creates one.
There can only be one implicit Publisher per DomainParticipant.
The implicit Publisher is created with com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT and no Listener.
This implicit Publisher will be deleted automatically when the following methods are called: com.rti.dds.domain.DomainParticipant.delete_contained_entities, or com.rti.dds.domain.DomainParticipant.delete_publisher with the implicit publisher as a parameter. Additionally, when a DomainParticipant is deleted, if there are no attached DataWriters that belong to the implicit Publisher, the implicit Publisher will be implicitly deleted.
Subscriber get_implicit_subscriber | ( | ) |
<<extension>> Returns the implicit com.rti.dds.subscription.Subscriber. If an implicit Subscriber does not already exist, this creates one.
There can only be one implicit Subscriber per DomainParticipant.
The implicit Subscriber is created with com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT and no Listener.
This implicit Subscriber will be deleted automatically when the following methods are called: com.rti.dds.domain.DomainParticipant.delete_contained_entities, or com.rti.dds.domain.DomainParticipant.delete_subscriber with the subscriber as a parameter. Additionally, when a DomainParticipant is deleted, if there are no attached DataReaders that belong to the implicit Subscriber, the implicit Subscriber will be implicitly deleted.
|
abstract |
<<extension>> Looks up a com.rti.dds.publication.Publisher by its entity name within this com.rti.dds.domain.DomainParticipant.
Every com.rti.dds.publication.Publisher in the system has an entity name which is configured and stored in the EntityName policy, ENTITY_NAME.
This operation retrieves a com.rti.dds.publication.Publisher within the com.rti.dds.domain.DomainParticipant given the entity's name. If there are several com.rti.dds.publication.Publisher with the same name within the com.rti.dds.domain.DomainParticipant, this function returns the first matching occurrence.
publisher_name | <<in>> Entity name of the com.rti.dds.publication.Publisher. |
|
abstract |
<<extension>> Retrieves a com.rti.dds.subscription.Subscriber by its entity name within this com.rti.dds.domain.DomainParticipant.
Every com.rti.dds.subscription.Subscriber in the system has an entity name which is configured and stored in the EntityName policy, ENTITY_NAME.
This operation retrieves a com.rti.dds.subscription.Subscriber within the com.rti.dds.domain.DomainParticipant given the entity's name. If there are several com.rti.dds.subscription.Subscriber with the same name within the com.rti.dds.domain.DomainParticipant, this function returns the first matching occurrence.
subscriber_name | <<in>> Entity name of the com.rti.dds.subscription.Subscriber. |
|
abstract |
<<extension>> Looks up a com.rti.dds.publication.DataWriter by its entity name within this com.rti.dds.domain.DomainParticipant.
Every com.rti.dds.publication.DataWriter in the system has an entity name which is configured and stored in the EntityName policy, ENTITY_NAME.
Every com.rti.dds.publication.Publisher in the system has an entity name which is also configured and stored in the EntityName policy.
This operation retrieves a com.rti.dds.publication.DataWriter within a com.rti.dds.publication.Publisher given the specified name which encodes both to the com.rti.dds.publication.DataWriter and the com.rti.dds.publication.Publisher name.
If there are several com.rti.dds.publication.DataWriter with the same name within the corresponding com.rti.dds.publication.Publisher this function returns the first matching occurrence.
The specified name might be given as a fully-qualified entity name or as a plain name.
The fully qualified entity name is a concatenation of the com.rti.dds.publication.Publisher to which the com.rti.dds.publication.DataWriter belongs and the entity name of of the com.rti.dds.publication.DataWriter itself, separated by a double colon "::". For example: MyPublisherName::MyDataWriterName
The plain name contains the com.rti.dds.publication.DataWriter name only. In this situation it is implied that the com.rti.dds.publication.DataWriter belongs to the implicit com.rti.dds.publication.Publisher so the use of a plain name is equivalent to specifying a fully qualified name with the com.rti.dds.publication.Publisher name part being "implicit". For example: the plain name "MyDataWriterName" is equivalent to specifiying the fully qualified name "implicit::MyDataWriterName"
The com.rti.dds.publication.DataWriter is only looked up within the com.rti.dds.publication.Publisher specified in the fully qualified name, or within the implicit com.rti.dds.publication.Publisher if the name was not fully qualified.
datawriter_full_name | <<in>> Entity name or fully-qualified entity name of the com.rti.dds.publication.DataWriter. |
|
abstract |
<<extension>> Retrieves up a com.rti.dds.subscription.DataReader by its entity name in this com.rti.dds.domain.DomainParticipant.
Every com.rti.dds.subscription.DataReader in the system has an entity name which is configured and stored in the EntityName policy, ENTITY_NAME.
Every com.rti.dds.subscription.Subscriber in the system has an entity name which is also configured and stored in the EntityName policy, ENTITY_NAME.
This operation retrieves a com.rti.dds.subscription.DataReader within a com.rti.dds.subscription.Subscriber given the specified name which encodes both to the com.rti.dds.subscription.DataReader and the com.rti.dds.subscription.Subscriber name.
If there are several com.rti.dds.subscription.DataReader with the same name within the corresponding com.rti.dds.subscription.Subscriber this function returns the first matching occurrence.
The specified name might be given as a fully-qualified entity name or as a plain name.
The fully qualified entity name is a concatenation of the com.rti.dds.subscription.Subscriber to which the com.rti.dds.subscription.DataReader belongs and the entity name of of the com.rti.dds.subscription.DataReader itself, separated by a double colon "::". For example: MySubscriberName::MyDataReaderName
The plain name contains the com.rti.dds.subscription.DataReader name only. In this situation it is implied that the com.rti.dds.subscription.DataReader belongs to the implicit com.rti.dds.subscription.Subscriber so the use of a plain name is equivalent to specifying a fully qualified name with the com.rti.dds.subscription.Subscriber name part being "implicit". For example: the plain name "MyDataReaderName" is equivalent to specifiying the fully qualified name "implicit::MyDataReaderName"
The com.rti.dds.subscription.DataReader is only looked up within the com.rti.dds.subscription.Subscriber specified in the fully qualified name, or within the implicit com.rti.dds.subscription.Subscriber if the name was not fully qualified.
datareader_full_name | <<in>> Full entity name of the com.rti.dds.subscription.DataReader. |
void take_discovery_snapshot | ( | ) |
Take a snapshot of the remote participants discovered by a local one.
The snapshot will be printed through the com.rti.ndds.config.Logger. A possible output may be the following:
One | of the Standard Return Codes. |
void take_discovery_snapshot | ( | String | file_name | ) |
Take a snapshot of the remote participants discovered by a local one.
The snapshot will be printed in the file specified by file_name. A possible output may be the following:
file_name | <<in>> Name of the file where snapshot should be printed. |
One | of the Standard Return Codes. |