| #define DDS_DomainParticipantListener_INITIALIZER |
Initializer for new DDS_DomainParticipantListener.
No memory is allocated. New DDS_DomainParticipantListener instances stored in the stack should be initialized with this value before they are passed to any functions.
struct DDS_DomainParticipantListener listener = DDS_DomainParticipantListener_INITIALIZER; /* initialize listener functions */ listener.as_subscriberlistener.as_datareaderlistener.on_data_available = ....; DDS_DomainParticipant_set_listener(myParticipant, &listener, mask);
| #define DDS_DomainParticipantQos_INITIALIZER |
Initializer for new QoS instances.
New DDS_DomainParticipantQos instances stored on the stack should be initialized with this value before they are passed to any functions. This step ensures that those contained QoS policies that use dynamic memory are properly initialized. This does not allocate memory.
The simplest way to create a new QoS structure is to initialize it on the stack at the time of its creation:
struct DDS_DomainParticipantQos myQos = DDS_DomainParticipantQos_INITIALIZER;
Note that the above assignment is not a substitute for calling DDS_DomainParticipant_get_qos or DDS_DomainParticipantFactory_get_default_participant_qos; one of those functions should be called subsequently to setting the QoS of any new or existing entity. DDS_DomainParticipantQos_finalize should be called to free the contained QoS policies that use dynamic memory:
struct DDS_DomainParticipantQos myQos = DDS_DomainParticipantQos_INITIALIZER; DDS_DomainParticipantFactory_get_default_participant_qos(myFactory, &myQos); DDS_DomainParticipant_set_qos(myParticipant, &myQos); DDS_DomainParticipantQos_finalize(&myQos);
| typedef struct DDS_DomainParticipantImpl DDS_DomainParticipant |
<<interface>> Container for all DDS_DomainEntity objects.
The DomainParticipant object plays several roles:
- It acts as a container for all other DDS_Entity objects.
- It acts as factory for the DDS_Publisher, DDS_Subscriber, DDS_Topic and DDS_MultiTopic DDS_Entity objects.
- It represents the participation of the application on a communication plane that isolates applications running on the same set of physical computers from each other. A domain establishes a virtual network linking all applications that share the same 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.
- It provides administration services in the domain, offering operations that allow the application to ignore locally any information about a given participant (ignore_participant()), publication (ignore_publication()), subscription (ignore_subscription()) or topic (ignore_topic()).
The following operations may be called even if the DDS_DomainParticipant is not enabled. (Operations NOT in this list will fail with the value DDS_RETCODE_NOT_ENABLED if called on a disabled DomainParticipant).
| DDS_ReturnCode_t DDS_DomainParticipantQos_initialize | ( | struct DDS_DomainParticipantQos * | self | ) |
Initializer for new QoS instances.
New DDS_DomainParticipantQos instances on heap should be initialized with this function before they are passed to any functions. This step ensures that those contained QoS policies that use dynamic memory are properly initialized. This function does not allocate memory.
Calling this function is not a substitute for calling DDS_DomainParticipant_get_qos or DDS_DomainParticipantFactory_get_default_participant_qos; one of those functions should be called subsequently to setting the QoS of any new or existing entity. DDS_DomainParticipantQos_finalize should be called to free the contained QoS policies that use dynamic memory:
DDS_DomainParticipantQos *myQos = malloc(sizeof(struct DDS_DomainParticipantQos)); DDS_DomainParticipantQos_initialize(myQos); DDS_DomainParticipantFactory_get_default_participant_qos(myFactory, myQos); DDS_DomainParticipant_set_qos(myParticipant, myQos); DDS_DomainParticipantQos_finalize(myQos); free(myQos);
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipantQos_copy | ( | struct DDS_DomainParticipantQos * | self, | |
| const struct DDS_DomainParticipantQos * | source | |||
| ) |
Copy the contents of the given QoS into this QoS.
DDS_DomainParticipantQos instances can use dynamic memory because of the sequences contained in some QoS policies. A shallow copy by assignment is therefore unsafe. This function performs a deep-copy, allocating memory if necessary.
| DDS_ReturnCode_t DDS_DomainParticipantQos_finalize | ( | struct DDS_DomainParticipantQos * | self | ) |
Free any dynamic memory allocated by the policies in this DDS_DomainParticipantQos.
Some QoS policies may use dynamic memory (regardless of whether the QoS itself is in dynamic memory). This function frees that memory but otherwise leaves this QoS unchanged. It should be called on all instances before they are freed (or, in the case of stack-based instances, before they go out of scope).
This function does not leave this object in an invalid state. It is permissable to finalize a QoS and then subsequently allocate new dynamic memory in one or more of its QoS policies.
Note that if this QoS instance is stored in heap memory, calling this function will not call free() on it; the user is responsible for explicitly freeing any heap-based QoS instance after calling this function.
| self | <<in>> Cannot be NULL. |
| DDS_Entity* DDS_DomainParticipant_as_entity | ( | DDS_DomainParticipant * | domain | ) |
Access a DDS_DomainParticipant's supertype instance.
| domain | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_get_default_topic_qos | ( | DDS_DomainParticipant * | self, | |
| struct DDS_TopicQos * | qos | |||
| ) |
Copies the default DDS_TopicQos values for this domain participant into the given DDS_TopicQos instance.
The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipant_set_default_topic_qos, or else, if the call was never made, the default values listed in DDS_TopicQos.
This function may potentially allocate memory depending on the sequences contained in some QoS policies.
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_topic_qos | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_TopicQos * | qos | |||
| ) |
Set the default DDS_TopicQos values for this domain participant.
This default value will be used for newly created DDS_Topic if DDS_TOPIC_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_topic is called.
qos parameter. | self | <<in>> Cannot be NULL. | |
| qos | <<in>> Default qos to be set. The special value DDS_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 DDS_DomainParticipant_set_default_topic_qos had never been called. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_topic_qos_with_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name, | |||
| const char * | profile_name | |||
| ) |
<<eXtension>> Set the default DDS_TopicQos values for this domain participant based on the input XML QoS profile.
This default value will be used for newly created DDS_Topic if DDS_TOPIC_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_topic is called.
qos parameter. | self | <<in>> Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). |
| DDS_ReturnCode_t DDS_DomainParticipant_get_default_publisher_qos | ( | DDS_DomainParticipant * | self, | |
| struct DDS_PublisherQos * | qos | |||
| ) |
Copy the default DDS_PublisherQos values into the provided DDS_PublisherQos instance.
The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipant_set_default_publisher_qos, or DDS_DomainParticipant_set_default_publisher_qos_with_profile, or else, if the call was never made, the default values listed in DDS_PublisherQos.
This function may potentially allocate memory depending on the sequences contained in some QoS policies.
If DDS_PUBLISHER_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_topic is called, the default value of the QoS set in the factory, equivalent to the value obtained by calling DDS_DomainParticipant_get_default_publisher_qos, will be used to create the DDS_Publisher.
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_publisher_qos | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_PublisherQos * | qos | |||
| ) |
Set the default DDS_PublisherQos values for this DomainParticipant.
This set of default values will be used for a newly created DDS_Publisher if DDS_PUBLISHER_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_publisher is called.
qos parameter. | self | <<in>> Cannot be NULL. | |
| qos | <<in>> Default qos to be set. The special value DDS_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 DDS_DomainParticipant_set_default_publisher_qos had never been called. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_publisher_qos_with_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name, | |||
| const char * | profile_name | |||
| ) |
<<eXtension>> Set the default DDS_PublisherQos values for this DomainParticipant based on the input XML QoS profile.
This set of default values will be used for a newly created DDS_Publisher if DDS_PUBLISHER_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_publisher is called.
qos parameter. | self | <<in>> Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). |
| DDS_ReturnCode_t DDS_DomainParticipant_get_default_datawriter_qos | ( | DDS_DomainParticipant * | self, | |
| struct DDS_DataWriterQos * | qos | |||
| ) |
<<eXtension>> Copy the default DDS_DataWriterQos values into the provided DDS_DataWriterQos instance.
The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipant_set_default_datawriter_qos, or DDS_DomainParticipant_set_default_datawriter_qos_with_profile, or else, if the call was never made, the default values listed in DDS_DataWriterQos.
This function may potentially allocate memory depending on the sequences contained in some QoS policies.
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_datawriter_qos | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_DataWriterQos * | qos | |||
| ) |
<<eXtension>> Set the default DataWriterQos values for this DomainParticipant.
This set of default values will be inherited for a newly created DDS_Publisher.
| self | <<in>> Cannot be NULL. | |
| qos | <<in>> Default qos to be set. The special value DDS_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 DDS_DomainParticipant_set_default_datawriter_qos had never been called. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_datawriter_qos_with_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name, | |||
| const char * | profile_name | |||
| ) |
<<eXtension>> Set the default DDS_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 DDS_Publisher.
| self | <<in>> Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). |
| DDS_ReturnCode_t DDS_DomainParticipant_get_default_subscriber_qos | ( | DDS_DomainParticipant * | self, | |
| struct DDS_SubscriberQos * | qos | |||
| ) |
Copy the default DDS_SubscriberQos values into the provided DDS_SubscriberQos instance.
The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipant_set_default_subscriber_qos, or DDS_DomainParticipant_set_default_subscriber_qos_with_profile, or else, if the call was never made, the default values listed in DDS_SubscriberQos.
This function may potentially allocate memory depending on the sequences contained in some QoS policies.
If DDS_SUBSCRIBER_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_subscriber is called, the default value of the QoS set in the factory, equivalent to the value obtained by calling DDS_DomainParticipant_get_default_subscriber_qos, will be used to create the DDS_Subscriber.
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_subscriber_qos | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_SubscriberQos * | qos | |||
| ) |
Set the default DDS_SubscriberQos values for this Domain{articipant.
This set of default values will be used for a newly created DDS_Subscriber if DDS_SUBSCRIBER_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_subscriber is called.
qos parameter. | self | <<in>> Cannot be NULL. | |
| qos | <<in>> Default qos to be set. The special value DDS_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 DDS_DomainParticipant_set_default_subscriber_qos had never been called. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_subscriber_qos_with_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name, | |||
| const char * | profile_name | |||
| ) |
<<eXtension>> Set the default DDS_SubscriberQos values for this DomainParticipant based on the input XML QoS profile.
This set of default values will be used for a newly created DDS_Subscriber if DDS_SUBSCRIBER_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_subscriber is called.
qos parameter. | self | <<in>> Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). |
| DDS_ReturnCode_t DDS_DomainParticipant_get_default_datareader_qos | ( | DDS_DomainParticipant * | self, | |
| struct DDS_DataReaderQos * | qos | |||
| ) |
<<eXtension>> Copy the default DDS_DataReaderQos values into the provided DDS_DataReaderQos instance.
The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipant_set_default_datareader_qos, or DDS_DomainParticipant_set_default_datareader_qos_with_profile, or else, if the call was never made, the default values listed in DDS_DataReaderQos.
This function may potentially allocate memory depending on the sequences contained in some QoS policies.
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_datareader_qos | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_DataReaderQos * | qos | |||
| ) |
<<eXtension>> Set the default DDS_DataReaderQos values for this domain participant.
This set of default values will be inherited for a newly created DDS_Subscriber.
| self | <<in>> Cannot be NULL. | |
| qos | <<in>> Default qos to be set. The special value DDS_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 DDS_DomainParticipant_set_default_datareader_qos had never been called. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_datareader_qos_with_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name, | |||
| const char * | profile_name | |||
| ) |
<<eXtension>> Set the default DDS_DataReaderQos values for this DomainParticipant based on the input XML QoS profile.
This set of default values will be inherited for a newly created DDS_Subscriber.
| self | <<in>> Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). |
| DDS_ReturnCode_t DDS_DomainParticipant_get_default_flowcontroller_property | ( | DDS_DomainParticipant * | self, | |
| struct DDS_FlowControllerProperty_t * | prop | |||
| ) |
<<eXtension>> Copies the default DDS_FlowControllerProperty_t values for this domain participant into the given DDS_FlowControllerProperty_t instance.
The retrieved property will match the set of values specified on the last successful call to DDS_DomainParticipant_set_default_flowcontroller_property, or else, if the call was never made, the default values listed in DDS_FlowControllerProperty_t.
| self | <<in>> Cannot be NULL. | |
| prop | <<in>> Default property to be retrieved. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_flowcontroller_property | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_FlowControllerProperty_t * | prop | |||
| ) |
<<eXtension>> Set the default DDS_FlowControllerProperty_t values for this domain participant.
This default value will be used for newly created DDS_FlowController if DDS_FLOW_CONTROLLER_PROPERTY_DEFAULT is specified as the property parameter when DDS_DomainParticipant_create_flowcontroller is called.
qos parameter. | self | <<in>> Cannot be NULL. | |
| prop | <<in>> Default property to be set. The special value DDS_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 DDS_DomainParticipant_set_default_flowcontroller_property had never been called. Cannot be NULL. |
| const char* DDS_DomainParticipant_get_default_library | ( | DDS_DomainParticipant * | self | ) |
<<eXtension>> Gets the default XML library associated with a DDS_DomainParticipant.
| self | <<in>> Cannot be NULL. |
| const char* DDS_DomainParticipant_get_default_profile | ( | DDS_DomainParticipant * | self | ) |
<<eXtension>> Gets the default XML profile associated with a DDS_DomainParticipant.
| self | <<in>> Cannot be NULL. |
| const char* DDS_DomainParticipant_get_default_profile_library | ( | DDS_DomainParticipant * | self | ) |
<<eXtension>> Gets the library where the default XML QoS profile is contained for a DDS_DomainParticipant.
The default profile library is automatically set when DDS_DomainParticipant_set_default_profile is called.
This library can be different than the DDS_DomainParticipant default library (see DDS_DomainParticipant_get_default_library).
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_library | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name | |||
| ) |
<<eXtension>> Sets the default XML library for a DDS_DomainParticipant.
This function 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 DDS_DomainParticipant inherits the default from the DDS_DomainParticipantFactory (see DDS_DomainParticipantFactory_set_default_library).
| self | <<in>> Cannot be NULL. | |
| library_name | <<in>> Library name. If library_name is null any previous default is unset. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_default_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name, | |||
| const char * | profile_name | |||
| ) |
<<eXtension>> Sets the default XML profile for a DDS_DomainParticipant.
This function 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 DDS_DomainParticipant function 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 DDS_DomainParticipant inherits the default from the DDS_DomainParticipantFactory (see DDS_DomainParticipantFactory_set_default_profile).
This function does not set the default QoS for entities created by the DDS_DomainParticipant; for this functionality, use the functions set_default_<entity>_qos_with_profile (you may pass in NULL after having called set_default_profile()).
This function does not set the default QoS for newly created DomainParticipants; for this functionality, use DDS_DomainParticipantFactory_set_default_participant_qos_with_profile.
| self | <<in>> Cannot be NULL. | |
| 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. |
| DDS_Publisher* DDS_DomainParticipant_create_publisher | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_PublisherQos * | qos, | |||
| const struct DDS_PublisherListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
Creates a DDS_Publisher with the desired QoS policies and attaches to it the specified DDS_PublisherListener.
if listener is specified, none of the listener callback functions can be NULL.
qos, it is not safe to create the publisher while another thread may be simultaneously calling DDS_DomainParticipant_set_default_publisher_qos. | self | <<in>> Cannot be NULL. | |
| qos | <<in>> QoS to be used for creating the new DDS_Publisher. The special value DDS_PUBLISHER_QOS_DEFAULT can be used to indicate that the DDS_Publisher should be created with the default DDS_PublisherQos set in the DDS_DomainParticipant. Cannot be NULL. | |
| listener | <<in>>. Listener to be attached to the newly created DDS_Publisher. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS_PublisherQos for rules on consistency among QoS
DDS_DomainParticipant_create_publisher_with_profile
| DDS_Publisher* DDS_DomainParticipant_create_publisher_with_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name, | |||
| const char * | profile_name, | |||
| const struct DDS_PublisherListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
<<eXtension>> Creates a new DDS_Publisher object using the DDS_PublisherQos associated with the input XML QoS profile.
if listener is specified, none of the listener callback functions can be NULL.
| self | <<in>> Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). | |
| listener | <<in>>. Listener to be attached to the newly created DDS_Publisher. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS_PublisherQos for rules on consistency among QoS
DDS_DomainParticipant_create_publisher
| DDS_ReturnCode_t DDS_DomainParticipant_delete_publisher | ( | DDS_DomainParticipant * | self, | |
| DDS_Publisher * | p | |||
| ) |
Deletes an existing DDS_Publisher.
DDS_Publisher must have been created by this DDS_DomainParticipant, or else it will fail with DDS_RETCODE_PRECONDITION_NOT_MET.
| self | <<in>> Cannot be NULL. | |
| p | <<in>> DDS_Publisher to be deleted. |
| DDS_Subscriber* DDS_DomainParticipant_create_subscriber | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_SubscriberQos * | qos, | |||
| const struct DDS_SubscriberListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
Creates a DDS_Subscriber with the desired QoS policies and attaches to it the specified DDS_SubscriberListener.
if listener is specified, none of the listener callback functions can be NULL.
qos, it is not safe to create the subscriber while another thread may be simultaneously calling DDS_DomainParticipant_set_default_subscriber_qos. | self | <<in>> Cannot be NULL. | |
| qos | <<in>> QoS to be used for creating the new DDS_Subscriber. The special value DDS_SUBSCRIBER_QOS_DEFAULT can be used to indicate that the DDS_Subscriber should be created with the default DDS_SubscriberQos set in the DDS_DomainParticipant. Cannot be NULL. | |
| listener | <<in>>. Listener to be attached to the newly created DDS_Subscriber. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS_SubscriberQos for rules on consistency among QoS
DDS_DomainParticipant_create_subscriber_with_profile
| DDS_Subscriber* DDS_DomainParticipant_create_subscriber_with_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name, | |||
| const char * | profile_name, | |||
| const struct DDS_SubscriberListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
<<eXtension>> Creates a new DDS_Subscriber object using the DDS_PublisherQos associated with the input XML QoS profile.
if listener is specified, none of the listener callback functions can be NULL.
| self | <<in>> Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). | |
| listener | <<in>>. Listener to be attached to the newly created DDS_Subscriber. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS_SubscriberQos for rules on consistency among QoS
DDS_DomainParticipant_create_subscriber
| DDS_ReturnCode_t DDS_DomainParticipant_delete_subscriber | ( | DDS_DomainParticipant * | self, | |
| DDS_Subscriber * | s | |||
| ) |
Deletes an existing DDS_Subscriber.
The DDS_Subscriber must have been created by this DDS_DomainParticipant, or else it will fail with DDS_RETCODE_PRECONDITION_NOT_MET.
| self | <<in>> Cannot be NULL. | |
| s | <<in>> DDS_Subscriber to be deleted. |
| DDS_DataWriter* DDS_DomainParticipant_create_datawriter | ( | DDS_DomainParticipant * | self, | |
| DDS_Topic * | topic, | |||
| const struct DDS_DataWriterQos * | qos, | |||
| const struct DDS_DataWriterListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
<<eXtension>> Creates a DDS_DataWriter that will be attached and belong to the implicit DDS_Publisher.
qos parameter, it is not safe to create the DataWriter while another thread may be simultaneously calling DDS_DomainParticipant_set_default_datawriter_qos. | self | <<in>> Cannot be NULL. | |
| topic | <<in>> The DDS_Topic that the DDS_DataWriter will be associated with. Cannot be NULL. | |
| qos | <<in>> QoS to be used for creating the new DDS_DataWriter. The special value DDS_DATAWRITER_QOS_DEFAULT can be used to indicate that the DDS_DataWriter should be created with the default DDS_DataWriterQos set in the implicit DDS_Publisher. The special value DDS_DATAWRITER_QOS_USE_TOPIC_QOS can be used to indicate that the DDS_DataWriter should be created with the combination of the default DDS_DataWriterQos set on the DDS_Publisher and the DDS_TopicQos of the DDS_Topic. Cannot be NULL. | |
| listener | <<in>> The listener of the DDS_DataWriter. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
Specifying QoS on entities for information on setting QoS before entity creation
DDS_DataWriterQos for rules on consistency among QoS
DDS_DATAWRITER_QOS_USE_TOPIC_QOS
DDS_DomainParticipant_create_datawriter_with_profile
DDS_DomainParticipant_get_default_datawriter_qos
| DDS_DataWriter* DDS_DomainParticipant_create_datawriter_with_profile | ( | DDS_DomainParticipant * | self, | |
| DDS_Topic * | topic, | |||
| const char * | library_name, | |||
| const char * | profile_name, | |||
| const struct DDS_DataWriterListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
<<eXtension>> Creates a DDS_DataWriter using a XML QoS profile that will be attached and belong to the implicit DDS_Publisher.
| self | <<in>> Cannot be NULL. | |
| topic | <<in>> The DDS_Topic that the DDS_DataWriter will be associated with. Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). | |
| listener | <<in>> The listener of the DDS_DataWriter. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
Specifying QoS on entities for information on setting QoS before entity creation
DDS_DataWriterQos for rules on consistency among QoS
DDS_DomainParticipant_create_datawriter
DDS_DomainParticipant_get_default_datawriter_qos
| DDS_ReturnCode_t DDS_DomainParticipant_delete_datawriter | ( | DDS_DomainParticipant * | self, | |
| DDS_DataWriter * | a_datawriter | |||
| ) |
<<eXtension>> Deletes a DDS_DataWriter that belongs to the implicit DDS_Publisher.
The deletion of the DDS_DataWriter will automatically unregister all instances. Depending on the settings of the WRITER_DATA_LIFECYCLE QosPolicy, the deletion of the DDS_DataWriter may also dispose all instances.
| self | <<in>> Cannot be NULL. | |
| a_datawriter | <<in>> The DDS_DataWriter to be deleted. |
| DDS_DataReader* DDS_DomainParticipant_create_datareader | ( | DDS_DomainParticipant * | self, | |
| DDS_TopicDescription * | topic, | |||
| const struct DDS_DataReaderQos * | qos, | |||
| const struct DDS_DataReaderListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
<<eXtension>> Creates a DDS_DataReader that will be attached and belong to the implicit DDS_Subscriber.
qos parameter, it is not safe to create the datareader while another thread may be simultaneously calling DDS_DomainParticipant_set_default_datareader_qos. | self | <<in>> Cannot be NULL. | |
| topic | <<in>> The DDS_TopicDescription that the DDS_DataReader will be associated with. Cannot be NULL. | |
| qos | <<in>> The qos of the DDS_DataReader. The special value DDS_DATAREADER_QOS_DEFAULT can be used to indicate that the DDS_DataReader should be created with the default DDS_DataReaderQos set in the implicit DDS_Subscriber. If DDS_TopicDescription is of type DDS_Topic or DDS_ContentFilteredTopic, the special value DDS_DATAREADER_QOS_USE_TOPIC_QOS can be used to indicate that the DDS_DataReader should be created with the combination of the default DDS_DataReaderQos set on the implicit DDS_Subscriber and the DDS_TopicQos (in the case of a DDS_ContentFilteredTopic, the DDS_TopicQos of the related DDS_Topic). if DDS_DATAREADER_QOS_USE_TOPIC_QOS is used, topic cannot be a DDS_MultiTopic. Cannot be NULL. | |
| listener | <<in>> The listener of the DDS_DataReader. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
Specifying QoS on entities for information on setting QoS before entity creation
DDS_DataReaderQos for rules on consistency among QoS
DDS_DomainParticipant_create_datareader_with_profile
DDS_DomainParticipant_get_default_datareader_qos
| DDS_DataReader* DDS_DomainParticipant_create_datareader_with_profile | ( | DDS_DomainParticipant * | self, | |
| DDS_TopicDescription * | topic, | |||
| const char * | library_name, | |||
| const char * | profile_name, | |||
| const struct DDS_DataReaderListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
<<eXtension>> Creates a DDS_DataReader using a XML QoS profile that will be attached and belong to the implicit DDS_Subscriber.
| self | <<in>> Cannot be NULL. | |
| topic | <<in>> The DDS_TopicDescription that the DDS_DataReader will be associated with. Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). | |
| listener | <<in>> The listener of the DDS_DataReader. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
Specifying QoS on entities for information on setting QoS before entity creation
DDS_DataReaderQos for rules on consistency among QoS
DDS_DomainParticipant_create_datareader
DDS_DomainParticipant_get_default_datareader_qos
| DDS_ReturnCode_t DDS_DomainParticipant_delete_datareader | ( | DDS_DomainParticipant * | self, | |
| DDS_DataReader * | a_datareader | |||
| ) |
<<eXtension>> Deletes a DDS_DataReader that belongs to the implicit DDS_Subscriber.
| self | <<in>> Cannot be NULL. | |
| a_datareader | <<in>> The DDS_DataReader to be deleted. |
| DDS_Topic* DDS_DomainParticipant_create_topic | ( | DDS_DomainParticipant * | self, | |
| const char * | topic_name, | |||
| const char * | type_name, | |||
| const struct DDS_TopicQos * | qos, | |||
| const struct DDS_TopicListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
Creates a DDS_Topic with the desired QoS policies and attaches to it the specified DDS_TopicListener.
topic_name attached to the same DDS_DomainParticipant. If the application attempts this, this function will fail and return a NULL topic. The specified QoS policies must be consistent, or the operation will fail and no DDS_Topic will be created.
Prior to creating a DDS_Topic, the type must have been registered with RTI Data Distribution Service. This is done using the FooTypeSupport_register_type operation on a derived class of the DDS_TypeSupport interface.
qos, it is not safe to create the topic while another thread may be simultaneously calling DDS_DomainParticipant_set_default_topic_qos. | self | <<in>> Cannot be NULL. | |
| 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 DDS_Topic will be bound. Cannot be NULL. | |
| qos | <<in>> QoS to be used for creating the new DDS_Topic. The special value DDS_TOPIC_QOS_DEFAULT can be used to indicate that the DDS_Topic should be created with the default DDS_TopicQos set in the DDS_DomainParticipant. Cannot be NULL. | |
| listener | <<in>>. Listener to be attached to the newly created DDS_Topic. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS_TopicQos for rules on consistency among QoS
DDS_DomainParticipant_create_topic_with_profile
| DDS_Topic* DDS_DomainParticipant_create_topic_with_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | topic_name, | |||
| const char * | type_name, | |||
| const char * | library_name, | |||
| const char * | profile_name, | |||
| const struct DDS_TopicListener * | listener, | |||
| DDS_StatusMask | mask | |||
| ) |
<<eXtension>> Creates a new DDS_Topic object using the DDS_PublisherQos associated with the input XML QoS profile.
topic_name attached to the same DDS_DomainParticipant. If the application attempts this, this function will fail and return a NULL topic. The DDS_TopicQos in the input profile must be consistent, or the operation will fail and no DDS_Topic will be created.
Prior to creating a DDS_Topic, the type must have been registered with RTI Data Distribution Service. This is done using the FooTypeSupport_register_type operation on a derived class of the DDS_TypeSupport interface.
| self | <<in>> Cannot be NULL. | |
| 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 DDS_Topic will be bound. Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipant_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipant_set_default_profile). | |
| listener | <<in>>. Listener to be attached to the newly created DDS_Topic. | |
| mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS_TopicQos for rules on consistency among QoS
DDS_DomainParticipant_create_topic
| DDS_ReturnCode_t DDS_DomainParticipant_delete_topic | ( | DDS_DomainParticipant * | self, | |
| DDS_Topic * | topic | |||
| ) |
Deletes a DDS_Topic.
Make sure no objects are using the topic. More specifically, there must be no existing DDS_DataReader, DDS_DataWriter, DDS_ContentFilteredTopic, or DDS_MultiTopic objects belonging to the same DDS_DomainParticipant that are using the DDS_Topic. If delete_topic is called on a DDS_Topic with any of these existing objects attached to it, it will fail with DDS_RETCODE_PRECONDITION_NOT_MET.
| DDS_ContentFilteredTopic* DDS_DomainParticipant_create_contentfilteredtopic | ( | DDS_DomainParticipant * | self, | |
| const char * | name, | |||
| DDS_Topic * | related_topic, | |||
| const char * | filter_expression, | |||
| const struct DDS_StringSeq * | expression_parameters | |||
| ) |
Creates a DDS_ContentFilteredTopic, that can be used to do content-based subscriptions.
The DDS_ContentFilteredTopic only relates to samples published under that DDS_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 DDS_DomainParticipant. If the application attempts this, this function will fail and returns NULL.
If related_topic does not belong to this DDS_DomainParticipant, this operation returns NULL.
This function will create a content filter using the builtin SQL filter which implements a superset of the DDS specification. This filter requires that all IDL types have been compiled with typecodes. If this precondition is not met, this operation returns NULL. Do not use rtiddsgen's -notypecode option if you want to use the builtin SQL filter.
| self | <<in>> Cannot be NULL. | |
| name | <<in>> Name for the new content filtered topic, must not exceed 255 characters. Cannot be NULL. | |
| related_topic | <<in>> DDS_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. |
| DDS_ContentFilteredTopic* DDS_DomainParticipant_create_contentfilteredtopic_with_filter | ( | DDS_DomainParticipant * | self, | |
| const char * | name, | |||
| const DDS_Topic * | related_topic, | |||
| const char * | filter_expression, | |||
| const struct DDS_StringSeq * | expression_parameters, | |||
| const char * | filter_name | |||
| ) |
<<eXtension>> Creates a DDS_ContentFilteredTopic using the specified filter to do content-based subscriptions.
| self | <<in>> Cannot be NULL. | |
| name | <<in>> Name for the new content filtered topic. Cannot exceed 255 characters. Cannot be NULL. | |
| related_topic | <<in>> DDS_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 DDS_DomainParticipant_register_contentfilter on the same DDS_DomainParticipant. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_delete_contentfilteredtopic | ( | DDS_DomainParticipant * | self, | |
| DDS_ContentFilteredTopic * | a_contentfilteredtopic | |||
| ) |
Deletes a DDS_ContentFilteredTopic.
The DDS_ContentFilteredTopic must be created by this DDS_DomainParticipant, or else this operation will fail with DDS_RETCODE_PRECONDITION_NOT_MET.
| DDS_ReturnCode_t DDS_DomainParticipant_register_contentfilter | ( | DDS_DomainParticipant * | self, | |
| const char * | filter_name, | |||
| const struct DDS_ContentFilter * | contentfilter | |||
| ) |
<<eXtension>> Register a content filter which can be used to create a DDS_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 rgister a custom filter.
To use a custom filter, it must be registered in the following places:
Each filter_name can only be used to registered a content filter once with a DDS_DomainParticipant.
| self | <<in>> Cannot be NULL. | |
| filter_name | <<in>> Name of the filter. The name must be unique within the DDS_DomainParticipant and must not exceed 255 characters. Cannot be NULL. | |
| contentfilter | <<in>> Content filter to be registered. Cannot be NULL. |
| void* DDS_DomainParticipant_lookup_contentfilter | ( | DDS_DomainParticipant * | self, | |
| const char * | filter_name | |||
| ) |
<<eXtension>> Lookup a content filter previously registered with DDS_DomainParticipant_register_contentfilter.
| DDS_ReturnCode_t DDS_DomainParticipant_unregister_contentfilter | ( | DDS_DomainParticipant * | self, | |
| const char * | filter_name | |||
| ) |
<<eXtension>> Unregister a content filter previously registered with DDS_DomainParticipant_register_contentfilter.
A filter_name can be unregistered only if it has been previously registered to the DDS_DomainParticipant with DDS_DomainParticipant_register_contentfilter.
The unregistration of filter is not allowed if there are any existing DDS_ContentFilteredTopic objects that are using the filter. If the operation is called on a filter with existing DDS_ContentFilteredTopic objects attached to it, this operation will fail with DDS_RETCODE_PRECONDITION_NOT_MET.
If there are still existing discovered DDS_DataReader s with the same filter_name and the filter's compile method of the filter have previously been called on the discovered DDS_DataReader s, finalize method of the filter will be called on those discovered DDS_DataReader s before the content filter is unregistered. This means filtering will now be performed on the application that is creating the DDS_DataReader.
| DDS_MultiTopic* DDS_DomainParticipant_create_multitopic | ( | DDS_DomainParticipant * | self, | |
| const char * | name, | |||
| const char * | type_name, | |||
| const char * | subscription_expression, | |||
| const struct DDS_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 DDS_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 DDS_DomainParticipant. If the application attempts this, this function will fail and return NULL. Prior to creating a DDS_MultiTopic, the type must have been registered with RTI Data Distribution Service. This is done using the FooTypeSupport_register_type operation on a derived class of the DDS_TypeSupport interface. Otherwise, this function will return NULL.
| self | <<in>> Cannot be NULL. | |
| name | <<in>> Name of the newly create DDS_MultiTopic. Cannot be NULL. | |
| type_name | <<in>> Cannot be NULL. | |
| subscription_expression | <<in>> Cannot be NULL. | |
| expression_parameters | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_delete_multitopic | ( | DDS_DomainParticipant * | self, | |
| DDS_MultiTopic * | a_multitopic | |||
| ) |
[Not supported (optional)] Deletes a DDS_MultiTopic.
The DDS_MultiTopic must be created by this DDS_DomainParticipant, or else this operation will fail with DDS_RETCODE_PRECONDITION_NOT_MET.
| DDS_FlowController* DDS_DomainParticipant_create_flowcontroller | ( | DDS_DomainParticipant * | self, | |
| const char * | name, | |||
| const struct DDS_FlowControllerProperty_t * | prop | |||
| ) |
<<eXtension>> Creates a DDS_FlowController with the desired property.
The created DDS_FlowController is associated with a DDS_DataWriter via DDS_PublishModeQosPolicy::flow_controller_name. A single DDS_FlowController may service multiple DDS_DataWriter instances, even if they belong to a different DDS_Publisher. The property determines how the DDS_FlowController shapes the network traffic.
property must be consistent, or the operation will fail and no DDS_FlowController will be created. property, it is not safe to create the flow controller while another thread may be simultaneously calling DDS_DomainParticipant_set_default_flowcontroller_property or trying to lookup that flow controller with DDS_DomainParticipant_lookup_flowcontroller. | self | <<in>> Cannot be NULL. | |
| name | <<in>> name of the DDS_FlowController to create. A DDS_DataWriter is associated with a DDS_FlowController by name. Limited to 255 characters. | |
| prop | <<in>> property to be used for creating the new DDS_FlowController. The special value DDS_FLOW_CONTROLLER_PROPERTY_DEFAULT can be used to indicate that the DDS_FlowController should be created with the default DDS_FlowControllerProperty_t set in the DDS_DomainParticipant. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_delete_flowcontroller | ( | DDS_DomainParticipant * | self, | |
| DDS_FlowController * | fc | |||
| ) |
<<eXtension>> Deletes an existing DDS_FlowController.
The DDS_FlowController must have been created by this DDS_DomainParticipant, or else it will fail with DDS_RETCODE_PRECONDITION_NOT_MET.
| self | <<in>> Cannot be NULL. | |
| fc | <<in>> The DDS_FlowController to be deleted. |
| DDS_Topic* DDS_DomainParticipant_find_topic | ( | DDS_DomainParticipant * | self, | |
| const char * | topic_name, | |||
| const struct DDS_Duration_t * | timeout | |||
| ) |
Finds an existing (or ready to exist) DDS_Topic, based on its name.
This call can be used to block for a specified duration to wait for the DDS_Topic to be created.
If the requested DDS_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 DDS_DomainParticipant_lookup_topicdescription.
The DDS_DomainParticipant must already be enabled.
Note: Each DDS_Topic obtained by DDS_DomainParticipant_find_topic must also be deleted by means of DDS_DomainParticipant_delete_topic. If DDS_Topic is obtained multiple times by means of DDS_DomainParticipant_find_topic or DDS_DomainParticipant_create_topic, it must also be deleted that same number of times using DDS_DomainParticipant_delete_topic.
| self | <<in>> Cannot be NULL. | |
| topic_name | <<in>> Name of the DDS_Topic to search for. Cannot be NULL. | |
| timeout | <<in>> The time to wait if the DDS_Topic does not exist already. Cannot be NULL. |
| DDS_TopicDescription* DDS_DomainParticipant_lookup_topicdescription | ( | DDS_DomainParticipant * | self, | |
| const char * | topic_name | |||
| ) |
Looks up an existing, locally created DDS_TopicDescription, based on its name.
DDS_TopicDescription is the base class for DDS_Topic, DDS_MultiTopic and DDS_ContentFilteredTopic. So you can narrow the DDS_TopicDescription returned from this operation to a DDS_Topic or DDS_ContentFilteredTopic as appropriate.
Unlike DDS_DomainParticipant_find_topic, which logically returns a new DDS_Topic object that must be independently deleted, this operation returns a reference to the original local object.
The DDS_DomainParticipant does not have to be enabled when you call lookup_topicdescription().
The returned topic may be either enabled or disabled.
| self | <<in>> Cannot be NULL. | |
| topic_name | <<in>> Name of DDS_TopicDescription to search for. This string must be no more than 255 characters; it cannot be NULL. |
| DDS_FlowController* DDS_DomainParticipant_lookup_flowcontroller | ( | DDS_DomainParticipant * | self, | |
| const char * | name | |||
| ) |
<<eXtension>> Looks up an existing locally-created DDS_FlowController, based on its name.
Looks up a previously created DDS_FlowController, including the built-in ones. Once a DDS_FlowController has been deleted, subsequent lookups will fail.
| self | <<in>> Cannot be NULL. | |
| name | <<in>> Name of DDS_FlowController to search for. Limited to 255 characters. Cannot be NULL. |
| DDS_Subscriber* DDS_DomainParticipant_get_builtin_subscriber | ( | DDS_DomainParticipant * | self | ) |
Accesses the built-in DDS_Subscriber.
Each DDS_DomainParticipant contains several built-in DDS_Topic objects as well as corresponding DDS_DataReader objects to access them. All of these DDS_DataReader objects belong to a single built-in DDS_Subscriber.
The built-in Topics are used to communicate information about other DDS_DomainParticipant, DDS_Topic, DDS_DataReader, and DDS_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 DDS_DomainParticipant is deleted.
| self | <<in>> Cannot be NULL. |
| DDS_Publisher* DDS_DomainParticipant_get_implicit_publisher | ( | DDS_DomainParticipant * | self | ) |
<<eXtension>> Returns the implicit DDS_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 DDS_PUBLISHER_QOS_DEFAULT and no Listener.
This implicit Publisher will be deleted automatically when the following functions are called: DDS_DomainParticipant_delete_contained_entities, or DDS_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.
| self | <<in>> Cannot be NULL. |
| DDS_Subscriber* DDS_DomainParticipant_get_implicit_subscriber | ( | DDS_DomainParticipant * | self | ) |
<<eXtension>> Returns the implicit DDS_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 DDS_SUBSCRIBER_QOS_DEFAULT and no Listener.
This implicit Subscriber will be deleted automatically when the following functions are called: DDS_DomainParticipant_delete_contained_entities, or DDS_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.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_ignore_participant | ( | DDS_DomainParticipant * | self, | |
| const DDS_InstanceHandle_t * | handle | |||
| ) |
Instructs RTI Data Distribution Service to locally ignore a remote DDS_DomainParticipant.
From the time of this call onwards, RTI Data Distribution Service will locally behave as if the remote participant did not exist. This means it will ignore any topic, publication, or subscription that originates on that DDS_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 DDS_ParticipantBuiltinTopicData to provide access control.
Application data can be associated with a DDS_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 DDS_DomainParticipant to ignore is identified by the handle argument. This handle is the one that appears in the DDS_SampleInfo retrieved when reading the data-samples available for the built-in DDS_DataReader to the DDS_DomainParticipant topic. The built-in DDS_DataReader is read with the same FooDataReader_read and FooDataReader_take operations used for any DDS_DataReader.
| self | <<in>> Cannot be NULL. | |
| handle | <<in>> DDS_InstanceHandle_t of the DDS_DomainParticipant to be ignored. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_ignore_topic | ( | DDS_DomainParticipant * | self, | |
| const DDS_InstanceHandle_t * | handle | |||
| ) |
Instructs RTI Data Distribution Service to locally ignore a DDS_Topic.
This means it will locally ignore any publication, or subscription to the DDS_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 DDS_Topic to ignore is identified by the handle argument. This is the handle of a DDS_Topic that appears in the DDS_SampleInfo retrieved when reading data samples from the built-in DDS_DataReader for the DDS_Topic.
| self | <<in>> Cannot be NULL. | |
| handle | <<in>> Handle of the DDS_Topic to be ignored. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_ignore_publication | ( | DDS_DomainParticipant * | self, | |
| const DDS_InstanceHandle_t * | handle | |||
| ) |
Instructs RTI Data Distribution Service to locally ignore a publication.
A publication is defined by the association of a topic name, user data, and partition set on the DDS_Publisher (see DDS_PublicationBuiltinTopicData). After this call, any data written by that publication's DDS_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 DDS_SampleInfo retrieved when reading data samples from the built-in DDS_DataReader for the publication topic. handle can be obtained by calling DDS_Entity_get_instance_handle for the local DataWriter.
| self | <<in>> Cannot be NULL. | |
| handle | <<in>> Handle of the DDS_DataWriter to be ignored. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_ignore_subscription | ( | DDS_DomainParticipant * | self, | |
| const DDS_InstanceHandle_t * | handle | |||
| ) |
Instructs RTI Data Distribution Service to locally ignore a subscription.
A subscription is defined by the association of a topic name, user data, and partition set on the DDS_Subscriber (see DDS_SubscriptionBuiltinTopicData). After this call, any data received related to that subscription's DDS_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 DDS_SampleInfo retrieved when reading data samples from the built-in DDS_DataReader for the subscription topic. handle can be obtained by calling DDS_Entity_get_instance_handle for the local DataReader.
| self | <<in>> Cannot be NULL. | |
| handle | <<in>> Handle of the DDS_DataReader to be ignored. Cannot be NULL. |
| DDS_DomainId_t DDS_DomainParticipant_get_domain_id | ( | DDS_DomainParticipant * | self | ) |
Get the unique domain identifier.
This operation retrieves the domain_id used to create the DDS_DomainParticipant. The domain_id identifies the DDS domain to which the DDS_DomainParticipant belongs. Each DDS domain represents a separate data 'communication plane' isolated from other domains.
| self | <<in>> Cannot be NULL. |
domainId that was used to create the domain | DDS_ReturnCode_t DDS_DomainParticipant_delete_contained_entities | ( | DDS_DomainParticipant * | self | ) |
Delete all the entities that were created by means of the "create" operations on the DDS_DomainParticipant.
This operation deletes all contained DDS_Publisher (including an implicit Publisher, if one exists), DDS_Subscriber (including implicit subscriber), DDS_Topic, DDS_ContentFilteredTopic, and DDS_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 DDS_DomainParticipant will end up deleting all the entities recursively contained in the DDS_DomainParticipant, that is also the DDS_DataWriter, DDS_DataReader, as well as the DDS_QueryCondition and DDS_ReadCondition objects belonging to the contained DDS_DataReader.
The operation will fail with DDS_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 DDS_DomainParticipant knowing that it has no contained entities.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_assert_liveliness | ( | DDS_DomainParticipant * | self | ) |
Manually asserts the liveliness of this DDS_DomainParticipant.
This is used in combination with the DDS_LivelinessQosPolicy to indicate to RTI Data Distribution Service that the entity remains active.
You need to use this operation if the DDS_DomainParticipant conatins DDS_DataWriter entities with the DDS_LivelinessQosPolicy::kind set to DDS_MANUAL_BY_PARTICIPANT_LIVELINESS_QOS and it only affects the liveliness of those DDS_DataWriter entities. Otherwise, it has no effect.
Note: writing data via the FooDataWriter_write or FooDataWriter_write_w_timestamp operation asserts liveliness on the DDS_DataWriter itself and its DDS_DomainParticipant. Consequently the use of assert_liveliness() is only needed if the application is not writing data regularly.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_get_publishers | ( | DDS_DomainParticipant * | self, | |
| struct DDS_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 DDS_RETCODE_OUT_OF_RESOURCES.
| self | <<in>> Cannot be NULL. | |
| publishers | <<inout>> a PublisherSeq object where the set or list of publishers will be returned |
| DDS_ReturnCode_t DDS_DomainParticipant_get_subscribers | ( | DDS_DomainParticipant * | self, | |
| struct DDS_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 DDS_RETCODE_OUT_OF_RESOURCES.
| self | <<in>> Cannot be NULL. | |
| subscribers | <<inout>> a SubscriberSeq object where the set or list of subscribers will be returned |
| DDS_ReturnCode_t DDS_DomainParticipant_get_current_time | ( | DDS_DomainParticipant * | self, | |
| struct DDS_Time_t * | current_time | |||
| ) |
Returns the current value of the time.
The current value of the time that RTI Data Distribution Service uses to time-stamp DDS_DataWriter and to set the reception-timestamp for the data updates that it receives.
| self | <<in>> Cannot be NULL. | |
| current_time | <<inout>> Current time to be filled up. Cannot be NULL. |
| DDS_Boolean DDS_DomainParticipant_contains_entity | ( | DDS_DomainParticipant * | self, | |
| const DDS_InstanceHandle_t * | a_handle | |||
| ) |
Completes successfully with DDS_BOOLEAN_TRUE if the referenced DDS_Entity is contained by the DDS_DomainParticipant.
This operation checks whether or not the given a_handle represents an DDS_Entity that was created from the DDS_DomainParticipant. The containment applies recursively. That is, it applies both to entities (DDS_TopicDescription, DDS_Publisher, or DDS_Subscriber) created directly using the DDS_DomainParticipant as well as entities created using a contained DDS_Publisher, or DDS_Subscriber as the factory, and so forth.
The instance handle for an DDS_Entity may be obtained from built-in topic data, from various statuses, or from the operation DDS_Entity_get_instance_handle.
| self | <<in>> Cannot be NULL. | |
| a_handle | <<in>> DDS_InstanceHandle_t of the DDS_Entity to be checked. |
| DDS_ReturnCode_t DDS_DomainParticipant_get_discovered_participants | ( | DDS_DomainParticipant * | self, | |
| struct DDS_InstanceHandleSeq * | participant_handles | |||
| ) |
Returns list of discovered DDS_DomainParticipant s.
This operation retrieves the list of DDS_DomainParticipant s that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the DDS_DomainParticipant_ignore_participant operation.
| self | <<in>> Cannot be NULL. | |
| participant_handles | <<inout>> DDS_InstanceHandleSeq to be filled with handles of the discovered DDS_DomainParticipant s |
| DDS_ReturnCode_t DDS_DomainParticipant_get_discovered_participant_data | ( | DDS_DomainParticipant * | self, | |
| struct DDS_ParticipantBuiltinTopicData * | participant_data, | |||
| const DDS_InstanceHandle_t * | participant_handle | |||
| ) |
Returns DDS_ParticipantBuiltinTopicData for the specified DDS_DomainParticipant .
This operation retrieves information on a DDS_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 DDS_DomainParticipant_ignore_participant operation.
The participant_handle must correspond to such a DomainParticipant. Otherwise, the operation will fail with PRECONDITION_NOT_MET.
Use the operation DDS_DomainParticipant_get_discovered_participants to find the DDS_DomainParticipant s that are currently discovered.
Note: This operation does not retrieve the DDS_ParticipantBuiltinTopicData::property. This information is available through DDS_DataReaderListener::on_data_available() (if a reader listener is installed on the DDS_ParticipantBuiltinTopicDataDataReader).
| self | <<in>> Cannot be NULL. | |
| participant_data | <<inout>> DDS_ParticipantBuiltinTopicData to be filled with the specified DDS_DomainParticipant 's data. | |
| participant_handle | <<in>> DDS_InstanceHandle_t of DDS_DomainParticipant. |
| DDS_ReturnCode_t DDS_DomainParticipant_get_discovered_topics | ( | DDS_DomainParticipant * | self, | |
| struct DDS_InstanceHandleSeq * | topic_handles | |||
| ) |
Returns list of discovered DDS_Topic objects.
This operation retrieves the list of DDS_Topic s that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the DDS_DomainParticipant_ignore_topic operation.
| self | <<in>> Cannot be NULL. | |
| topic_handles | <<inout>> DDS_InstanceHandleSeq to be filled with handles of the discovered DDS_Topic objects |
| DDS_ReturnCode_t DDS_DomainParticipant_get_discovered_topic_data | ( | DDS_DomainParticipant * | self, | |
| struct DDS_TopicBuiltinTopicData * | topic_data, | |||
| const DDS_InstanceHandle_t * | topic_handle | |||
| ) |
Returns DDS_TopicBuiltinTopicData for the specified DDS_Topic.
This operation retrieves information on a DDS_Topic that has been discovered by the local Participant and must not have been "ignored" by means of the DDS_DomainParticipant_ignore_topic operation.
The topic_handle must correspond to such a topic. Otherwise, the operation will fail with DDS_RETCODE_PRECONDITION_NOT_MET.
This call is not supported for remote topics. If a remote topic_handle is used, the operation will fail with DDS_RETCODE_UNSUPPORTED.
Use the operation DDS_DomainParticipant_get_discovered_topics to find the topics that are currently discovered.
| self | <<in>> Cannot be NULL. | |
| topic_data | <<inout>> DDS_TopicBuiltinTopicData to be filled with the specified DDS_Topic's data. | |
| topic_handle | <<in>> DDS_InstanceHandle_t of DDS_Topic. |
| DDS_ReturnCode_t DDS_DomainParticipant_add_peer | ( | DDS_DomainParticipant * | self, | |
| const char * | 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 DDS_DomainParticipant will try to communicate.
This function may be called at any time after this DDS_DomainParticipant has been created (before or after it has been enabled).
If this function is called after DDS_Entity_enable, an attempt will be made to contact the new peer(s) immediately.
If this function is called before the DomainParticipant is enabled, the peer description will simply be added to the list that was populated by DDS_DiscoveryQosPolicy::initial_peers; the first attempted contact will take place after this DDS_DomainParticipant is enabled.
Adding a peer description with this function does not guarantee that any peer(s) discovered as a result will exactly correspond to those described:
To remove specific peer locators, you may use DDS_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 DDS_DomainParticipant that has been discovered, use DDS_DomainParticipant_ignore_participant.
Adding a peer description with this function has no effect on the DDS_DiscoveryQosPolicy::initial_peers that may be subsequently retrieved with DDS_DomainParticipant_get_qos() (because DDS_DiscoveryQosPolicy is immutable).
| self | <<in>> Cannot be NULL. | |
| peer_desc_string | <<in>> New peer descriptor to be added. The format is specified in Peer Descriptor Format. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_remove_peer | ( | DDS_DomainParticipant * | self, | |
| const char * | peer_desc_string | |||
| ) |
<<eXtension>> Remove one or more peer participants from the list of peers with which this DDS_DomainParticipant will try to communicate.
This function may be called any time after this DDS_DomainParticipant has been enabled
Calling this function has the following effects:
Removing a peer description with this function has no effect on the DDS_DiscoveryQosPolicy::initial_peers that may be subsequently retrieved with DDS_DomainParticipant_get_qos() (because DDS_DiscoveryQosPolicy is immutable).
| self | <<in>> Cannot be NULL. | |
| peer_desc_string | <<in>> Peer descriptor to be removed. The format is specified in Peer Descriptor Format. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_qos | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_DomainParticipantQos * | qos | |||
| ) |
Change the QoS of this DomainParticipant.
The DDS_DomainParticipantQos::user_data and DDS_DomainParticipantQos::entity_factory can be changed. The other policies are immutable.
| self | <<in>> Cannot be NULL. | |
| qos | <<in>> Set of policies to be applied to DDS_DomainParticipant. Policies must be consistent. Immutable policies cannot be changed after DDS_DomainParticipant is enabled. The special value DDS_PARTICIPANT_QOS_DEFAULT can be used to indicate that the QoS of the DDS_DomainParticipant should be changed to match the current default DDS_DomainParticipantQos set in the DDS_DomainParticipantFactory. Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_set_qos_with_profile | ( | DDS_DomainParticipant * | self, | |
| const char * | library_name, | |||
| const char * | profile_name | |||
| ) |
<<eXtension>> Change the QoS of this domain participant using the input XML QoS profile.
The DDS_DomainParticipantQos::user_data and DDS_DomainParticipantQos::entity_factory can be changed. The other policies are immutable.
| self | <<in>> Cannot be NULL. | |
| library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS_DomainParticipantFactory_set_default_library). | |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS_DomainParticipantFactory_set_default_profile). |
| DDS_ReturnCode_t DDS_DomainParticipant_get_qos | ( | DDS_DomainParticipant * | self, | |
| struct DDS_DomainParticipantQos * | qos | |||
| ) |
Get the participant QoS.
This function may potentially allocate memory depending on the sequences contained in some QoS policies.
| DDS_ReturnCode_t DDS_DomainParticipant_set_listener | ( | DDS_DomainParticipant * | self, | |
| const struct DDS_DomainParticipantListener * | l, | |||
| DDS_StatusMask | mask | |||
| ) |
Sets the participant listener.
| self | <<in>> Cannot be NULL. | |
| l | <<in>> Listener to be installed on entity. | |
| mask | <<in>> Changes of communication status to be invoked on the listener. The callback function on the listener cannot be NULL if the corresponding status is turned on in the mask. |
Once a participant has been enabled, it is therefore important that the listener not be changed unless some application-specific means are available of ensuring that the old listener cannot be concurrently in use. If this contract is violated, it is possible for the DDS_Listener::listener_data field to have been changed without the callback function pointers having been changed (or vica versa); callback functions may therefore be passed an incorrect DDS_Listener::listener_data value.
| struct DDS_DomainParticipantListener DDS_DomainParticipant_get_listener | ( | DDS_DomainParticipant * | self | ) | [read] |
Get the participant listener.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_DomainParticipant_get_listenerX | ( | DDS_DomainParticipant * | self, | |
| struct DDS_DomainParticipantListener * | listener | |||
| ) |
<<eXtension>> Get the participant listener.
An alternative form of DDS_DomainParticipant_get_listener that fills in an existing listener structure rather than returning one on the stack.
Special value for creating a DDS_Topic with default QoS.
When used in DDS_DomainParticipant_create_topic, this special value is used to indicate that the DDS_Topic should be created with the default DDS_Topic QoS by means of the operation get_default_topic_qos and using the resulting QoS to create the DDS_Topic.
When used in DDS_DomainParticipant_set_default_topic_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_DomainParticipant_set_default_topic_qos operation had never been called.
When used in DDS_Topic_set_qos, this special value is used to indicate that the QoS of the DDS_Topic should be changed to match the current default QoS set in the DDS_DomainParticipant that the DDS_Topic belongs to.
Note: You cannot use this value to get the default QoS values for a Topic; for this purpose, use DDS_DomainParticipant_get_default_topic_qos.
Special value for creating a DDS_Publisher with default QoS.
When used in DDS_DomainParticipant_create_publisher, this special value is used to indicate that the DDS_Publisher should be created with the default DDS_Publisher QoS by means of the operation get_default_publisher_qos and using the resulting QoS to create the DDS_Publisher.
When used in DDS_DomainParticipant_set_default_publisher_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_DomainParticipant_set_default_publisher_qos operation had never been called.
When used in DDS_Publisher_set_qos, this special value is used to indicate that the QoS of the DDS_Publisher should be changed to match the current default QoS set in the DDS_DomainParticipant that the DDS_Publisher belongs to.
Note: You cannot use this value to get the default QoS values for a Publisher; for this purpose, use DDS_DomainParticipant_get_default_publisher_qos.
Special value for creating a DDS_Subscriber with default QoS.
When used in DDS_DomainParticipant_create_subscriber, this special value is used to indicate that the DDS_Subscriber should be created with the default DDS_Subscriber QoS by means of the operation get_default_subscriber_qos and using the resulting QoS to create the DDS_Subscriber.
When used in DDS_DomainParticipant_set_default_subscriber_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_DomainParticipant_set_default_subscriber_qos operation had never been called.
When used in DDS_Subscriber_set_qos, this special value is used to indicate that the QoS of the DDS_Subscriber should be changed to match the current default QoS set in the DDS_DomainParticipant that the DDS_Subscriber belongs to.
Note: You cannot use this value to get the default QoS values for a Subscriber; for this purpose, use DDS_DomainParticipant_get_default_subscriber_qos.
<<eXtension>> Special value for creating a DDS_FlowController with default property.
When used in DDS_DomainParticipant_create_flowcontroller, this special value is used to indicate that the DDS_FlowController should be created with the default DDS_FlowController property by means of the operation get_default_flowcontroller_property and using the resulting QoS to create the DDS_FlowControllerProperty_t.
When used in DDS_DomainParticipant_set_default_flowcontroller_property, 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_DomainParticipant_set_default_flowcontroller_property operation had never been called.
When used in DDS_FlowController_set_property, this special value is used to indicate that the property of the DDS_FlowController should be changed to match the current default property set in the DDS_DomainParticipant that the DDS_FlowController belongs to.
Note: You cannot use this value to get the default property values for a FlowController; for this purpose, use .
| const char* const DDS_SQLFILTER_NAME |
<<eXtension>> The name of the built-in SQL filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.
| const char* const DDS_STRINGMATCHFILTER_NAME |
<<eXtension>> The name of the built-in StringMatch filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.
The StringMatch Filter is a subset of the SQL filter; it only supports the MATCH relational operator on a single string field.
RTI Data Distribution Service C API Version 4.5e
Copyright © 23 Oct 2011
Real-Time Innovations, Inc