|
RTI Connext C API
Version 6.1.2
|
DDS_Publisher entity and associated elements More...
Data Structures | |
| struct | DDS_PublisherSeq |
Declares IDL sequence < DDS_Publisher > . More... | |
| struct | DDS_PublisherQos |
| QoS policies supported by a DDS_Publisher entity. More... | |
| struct | DDS_PublisherListener |
| <<interface>> DDS_Listener for DDS_Publisher status. More... | |
Macros | |
| #define | DDS_PublisherQos_INITIALIZER |
| Initializer for new QoS instances. More... | |
| #define | DDS_PublisherListener_INITIALIZER |
| Initializer for new DDS_PublisherListener. More... | |
Typedefs | |
| typedef struct DDS_PublisherImpl | DDS_Publisher |
| <<interface>> A publisher is the object responsible for the actual dissemination of publications. More... | |
Variables | |
| const struct DDS_DataWriterQos * | DDS_DATAWRITER_QOS_PRINT_ALL |
| Special value which can be supplied to DDS_DataWriterQos_to_string_w_params indicating that all of the QoS should be printed. More... | |
| const struct DDS_DataWriterQos | DDS_DATAWRITER_QOS_DEFAULT |
| Special value for creating DDS_DataWriter with default QoS. More... | |
| const struct DDS_DataWriterQos | DDS_DATAWRITER_QOS_USE_TOPIC_QOS |
| Special value for creating DDS_DataWriter with a combination of the default DDS_DataWriterQos and the DDS_TopicQos. More... | |
DDS_Publisher entity and associated elements
| #define DDS_PublisherQos_INITIALIZER |
Initializer for new QoS instances.
New DDS_PublisherQos instance stored on the stack should be initialized with this value before they are passed to any function. 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:
Note that the above assignment is not a substitute for calling DDS_DomainParticipant_get_default_publisher_qos or DDS_Publisher_get_qos; one of those should be called subsequently to setting the QoS of a new or existing entity:
| #define DDS_PublisherListener_INITIALIZER |
Initializer for new DDS_PublisherListener.
All the new DDS_PublisherListener instances allocated in the stack should be initialized to this value.No memory is allocated.
| typedef struct DDS_PublisherImpl DDS_Publisher |
<<interface>> A publisher is the object responsible for the actual dissemination of publications.
A publisher acts on the behalf of one or several DDS_DataWriter objects that belong to it. When it is informed of a change to the data associated with one of its DDS_DataWriter objects, it decides when it is appropriate to actually send the data-update message. In making this decision, it considers any extra information that goes with the data (timestamp, writer, etc.) as well as the QoS of the DDS_Publisher and the DDS_DataWriter.
The following operations may be called even if the DDS_Publisher is not enabled. Other operations will fail with the value DDS_RETCODE_NOT_ENABLED if called on a disabled DDS_Publisher:
| DDS_Boolean DDS_PublisherQos_equals | ( | const struct DDS_PublisherQos * | self, |
| const struct DDS_PublisherQos * | other | ||
| ) |
Compares two DDS_PublisherQos for equality.
| self | <<in>> This PublisherQos. |
| other | <<in>> The other PublisherQos to be compared with this PublisherQos. |
| DDS_ReturnCode_t DDS_PublisherQos_print | ( | const struct DDS_PublisherQos * | self | ) |
Prints this DDS_PublisherQos to stdout.
Only the differences between this DDS_PublisherQos and the documented default are printed. If you wish to print everything regardless, see DDS_PublisherQos_to_string_w_params. The output is formatted according to the default values for DDS_QosPrintFormat.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_PublisherQos_to_string | ( | const struct DDS_PublisherQos * | self, |
| char * | string, | ||
| DDS_UnsignedLong * | string_size | ||
| ) |
Obtains a string representation of this DDS_PublisherQos.
Only the differences between this DDS_PublisherQos and the documented default are printed to idref_PublisherQose string. If you wish to print everything regardless, see DDS_PublisherQos_to_string_w_params. The output is formatted according to the default values for DDS_QosPrintFormat.
If the supplied buffer is NULL, the required length of the string is returned via the string_size parameter.
If the supplied buffer is not NULL, the string representation of the DDS_PublisherQos is written to the buffer.
| self | <<in>> Cannot be NULL. |
| string | <<out>> The char buffer that will be used to store the string representation of this DDS_PublisherQos. If NULL, this function will return the required length of this buffer through the string_size parameter. |
| string_size | <<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer. |
| DDS_ReturnCode_t DDS_PublisherQos_to_string_w_params | ( | const struct DDS_PublisherQos * | self, |
| char * | string, | ||
| DDS_UnsignedLong * | string_size, | ||
| const struct DDS_PublisherQos * | base, | ||
| const struct DDS_QosPrintFormat * | format | ||
| ) |
Obtains a string representation of this DDS_PublisherQos.
Only the differences between this DDS_PublisherQos and the DDS_PublisherQos supplied as the base are printed to the string.
It is possible to supply the sentinel value DDS_PUBLISHER_QOS_PRINT_ALL as the base to print everything within the QoS.
If the supplied buffer is NULL, the required length of the string is returned via the string_size parameter.
If the supplied buffer is not NULL, the string representation of the DDS_PublisherQos is written to the buffer.
| self | <<in>> Cannot be NULL. |
| string | <<out>> The char buffer that will be used to store the string representation of this DDS_PublisherQos. If NULL, this function will return the required length of this buffer through the string_size parameter. |
| string_size | <<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer. |
| base | <<in>> The DDS_PublisherQos to be used as the base QoS profile. Only the differences with respect to this base profile will be included in the output string. |
| format | <<in>> The DDS_QosPrintFormat to be used to format the output string. |
| DDS_ReturnCode_t DDS_PublisherQos_initialize | ( | struct DDS_PublisherQos * | self | ) |
Initializer for new QoS instances.
New DDS_PublisherQos instances on heap should be initialized with this function before they are passed to any function. 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_Publisher_get_qos or DDS_DomainParticipant_get_default_publisher_qos; one of those should be called subsequently to setting the QoS of any new or existing entity. DDS_PublisherQos_finalize should be called to free the contained QoS policies that use dynamic memory:
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_PublisherQos_finalize | ( | struct DDS_PublisherQos * | self | ) |
Free any dynamic memory allocated by the policies in this DDS_PublisherQos.
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 clear 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_ReturnCode_t DDS_PublisherQos_copy | ( | struct DDS_PublisherQos * | self, |
| const struct DDS_PublisherQos * | source | ||
| ) |
Copy the contents of the given QoS into this QoS.
DDS_PublisherQos 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.
| self | <<in>> Cannot be NULL. |
| source | <<in>> The DDS_PublisherQos to copy from. |
| DDS_Entity* DDS_Publisher_as_entity | ( | DDS_Publisher * | publisher | ) |
Access a DDS_Publisher's supertype instance.
| publisher | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_get_default_datawriter_qos | ( | DDS_Publisher * | self, |
| struct DDS_DataWriterQos * | qos | ||
| ) |
Copies 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_Publisher_set_default_datawriter_qos or DDS_Publisher_set_default_datawriter_qos_with_profile, or else, if the call was never made, the default values from its owning DDS_DomainParticipant.
This function may potentially allocate memory depending on the sequences contained in some QoS policies.
| self | <<in>> Cannot be NULL. |
| qos | <<inout>> DDS_DataWriterQos to be filled-up. Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_set_default_datawriter_qos | ( | DDS_Publisher * | self, |
| const struct DDS_DataWriterQos * | qos | ||
| ) |
Sets the default DDS_DataWriterQos values for this publisher.
This call causes the default values inherited from the owning DDS_DomainParticipant to be overridden.
This default value will be used for newly created DDS_DataWriter if DDS_DATAWRITER_QOS_DEFAULT is specified as the qos parameter when DDS_Publisher_create_datawriter is called.
qos parameter. | 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_Publisher_set_default_datawriter_qos had never been called. Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_set_default_datawriter_qos_with_profile | ( | DDS_Publisher * | self, |
| const char * | library_name, | ||
| const char * | profile_name | ||
| ) |
<<extension>> Set the default DDS_DataWriterQos values for this publisher based on the input XML QoS profile.
This default value will be used for newly created DDS_DataWriter if DDS_DATAWRITER_QOS_DEFAULT is specified as the qos parameter when DDS_Publisher_create_datawriter 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 Connext will use the default library (see DDS_Publisher_set_default_library). |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS_Publisher_set_default_profile). |
If the input profile cannot be found, the function fails with DDS_RETCODE_ERROR.
| DDS_ReturnCode_t DDS_Publisher_set_default_profile | ( | DDS_Publisher * | self, |
| const char * | library_name, | ||
| const char * | profile_name | ||
| ) |
<<extension>> Sets the default XML profile for a DDS_Publisher.
This function specifies the profile that will be used as the default the next time a default Publisher profile is needed during a call to one of this Publisher's operations. When calling a DDS_Publisher 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_Publisher inherits the default from the DDS_DomainParticipant (see DDS_DomainParticipant_set_default_profile).
This function does not set the default QoS for DDS_DataWriter objects created by the DDS_Publisher; for this functionality, use DDS_Publisher_set_default_datawriter_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 Publishers; for this functionality, use DDS_DomainParticipant_set_default_publisher_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_ReturnCode_t DDS_Publisher_set_default_library | ( | DDS_Publisher * | self, |
| const char * | library_name | ||
| ) |
<<extension>> Sets the default XML library for a DDS_Publisher.
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 Publisher'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_Publisher inherits the default from the DDS_DomainParticipant (see DDS_DomainParticipant_set_default_library).
| self | <<in>> Cannot be NULL. |
| library_name | <<in>> Library name. If library_name is null any previous default is unset. |
| DDS_DataWriter* DDS_Publisher_create_datawriter | ( | DDS_Publisher * | self, |
| DDS_Topic * | topic, | ||
| const struct DDS_DataWriterQos * | qos, | ||
| const struct DDS_DataWriterListener * | listener, | ||
| DDS_StatusMask | mask | ||
| ) |
Creates a DDS_DataWriter that will be attached and belong to the DDS_Publisher.
For each application-defined type, Foo, there is an implied, auto-generated class FooDataWriter that extends DDS_DataWriter and contains the operations to write data of type Foo.
Note that a common application pattern to construct the QoS for the DDS_DataWriter is to:
When a DDS_DataWriter is created, only those transports already registered are available to the DDS_DataWriter. See Built-in Transport Plugins for details on when a builtin transport is registered.
qos parameter, it is not safe to create the datawriter while another thread may be simultaneously calling DDS_Publisher_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 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. See DDS_StatusMask. |
| DDS_DataWriter* DDS_Publisher_create_datawriter_with_profile | ( | DDS_Publisher * | 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 object using the DDS_DataWriterQos associated with the input XML QoS profile.
The DDS_DataWriter will be attached and belong to the DDS_Publisher.
For each application-defined type, Foo, there is an implied, auto-generated class FooDataWriter that extends DDS_DataWriter and contains the operations to write data of type Foo.
When a DDS_DataWriter is created, only those transports already registered are available to the DDS_DataWriter. See Built-in Transport Plugins for details on when a builtin transport is registered.
| 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 Connext will use the default library (see DDS_Publisher_set_default_library). |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS_Publisher_set_default_profile). |
| listener | <<in>> The listener of the DDS_DataWriter. |
| mask | <<in>>. Changes of communication status to be invoked on the listener. See DDS_StatusMask. |
| DDS_ReturnCode_t DDS_Publisher_delete_datawriter | ( | DDS_Publisher * | self, |
| DDS_DataWriter * | a_datawriter | ||
| ) |
Deletes a DDS_DataWriter that belongs to the DDS_Publisher.
The deletion of the DDS_DataWriter will automatically unregister all instances.
| self | <<in>> Cannot be NULL. |
| a_datawriter | <<in>> The DDS_DataWriter to be deleted. |
| DDS_DataWriter* DDS_Publisher_lookup_datawriter | ( | DDS_Publisher * | self, |
| const char * | topic_name | ||
| ) |
Retrieves the DDS_DataWriter for a specific DDS_Topic.
This returned DDS_DataWriter is either enabled or disabled.
If more than one DDS_DataWriter is attached to the DDS_Publisher with the same topic_name, then this operation may return any one of them.
| self | <<in>> Cannot be NULL. |
| topic_name | <<in>> Name of the DDS_Topic associated with the DDS_DataWriter that is to be looked up. Cannot be NULL. |
topic_name. If no such DDS_DataWriter exists, this operation returns NULL. | DDS_ReturnCode_t DDS_Publisher_suspend_publications | ( | DDS_Publisher * | self | ) |
Indicates to RTI Connext that the application is about to make multiple modifications using DDS_DataWriter objects belonging to the DDS_Publisher.
It is a hint to RTI Connext so it can optimize its performance by e.g., holding the dissemination of the modifications and then batching them.
The use of this operation must be matched by a corresponding call to DDS_Publisher_resume_publications indicating that the set of modifications has completed.
If the DDS_Publisher is deleted before DDS_Publisher_resume_publications is called, any suspended updates yet to be published will be discarded.
RTI Connext is not required and does not currently make use of this hint in any way. However, similar results can be achieved by using asynchronous publishing. Combined with DDS_FlowController, DDS_ASYNCHRONOUS_PUBLISH_MODE_QOS DDS_DataWriter instances allow the user even finer control of traffic shaping and sample coalescing.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_resume_publications | ( | DDS_Publisher * | self | ) |
Indicates to RTI Connext that the application has completed the multiple changes initiated by the previous DDS_Publisher_suspend_publications.
This is a hint to RTI Connext that can be used for example, to batch all the modifications made since the DDS_Publisher_suspend_publications.
RTI Connext is not required and does not currently make use of this hint in any way. However, similar results can be achieved by using asynchronous publishing. Combined with DDS_FlowController, DDS_ASYNCHRONOUS_PUBLISH_MODE_QOS DDS_DataWriter instances allow the user even finer control of traffic shaping and sample coalescing.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_begin_coherent_changes | ( | DDS_Publisher * | self | ) |
Indicates that the application will begin a coherent set of modifications using DDS_DataWriter objects attached to the DDS_Publisher.
A 'coherent set' is a set of modifications that must be propagated in such a way that they are interpreted at the receiver's side as a consistent set of modifications; that is, the receiver will only be able to access the data after all the modifications in the set are available at the receiver end.
A connectivity change may occur in the middle of a set of coherent changes; for example, the set of partitions used by the DDS_Publisher or one of its subscribers (DDS_Subscriber) may change, a late-joining DDS_DataReader may appear on the network, or a communication failure may occur. In the event that such a change prevents an entity from receiving the entire set of coherent changes, that entity must behave as if it had received none of the set.
These calls can be nested. In that case, the coherent set terminates only with the last call to DDS_Publisher_end_coherent_changes. Publisher's samples (samples published by any of the DataWriters within the Publisher) that are not published within a begin_coherent_changes/end_coherent_changes block will not be provided to the DataReaders as a set.
The support for coherent changes enables a publishing application to change the value of several data-instances that could belong to the same or different topics and have those changes be seen atomically by the readers. This is useful in cases where the values are inter-related (for example, if there are two data-instances representing the altitude and velocity vector of the same aircraft and both are changed, it may be useful to communicate those values in a way the reader can see both together; otherwise, it may, e.g., erroneously interpret that the aircraft is on a collision course).
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_end_coherent_changes | ( | DDS_Publisher * | self | ) |
Terminates the coherent set initiated by the matching call to DDS_Publisher_begin_coherent_changes.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_get_all_datawriters | ( | DDS_Publisher * | self, |
| struct DDS_DataWriterSeq * | writers | ||
| ) |
Retrieve all the DataWriters created from this Publisher.
| DDS_DomainParticipant* DDS_Publisher_get_participant | ( | DDS_Publisher * | self | ) |
Returns the DDS_DomainParticipant to which the DDS_Publisher belongs.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_delete_contained_entities | ( | DDS_Publisher * | self | ) |
Deletes all the entities that were created by means of the "create" operation on the DDS_Publisher.
Deletes all contained DDS_DataWriter objects. Once DDS_Publisher_delete_contained_entities completes successfully, the application may delete the DDS_Publisher, knowing that it has no contained DDS_DataWriter objects.
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.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_copy_from_topic_qos | ( | DDS_Publisher * | self, |
| struct DDS_DataWriterQos * | a_datawriter_qos, | ||
| const struct DDS_TopicQos * | a_topic_qos | ||
| ) |
Copies the policies in the DDS_TopicQos to the corresponding policies in the DDS_DataWriterQos.
Copies the policies in the DDS_TopicQos to the corresponding policies in the DDS_DataWriterQos (replacing values in the DDS_DataWriterQos, if present).
This is a "convenience" operation most useful in combination with the operations DDS_Publisher_get_default_datawriter_qos and DDS_Topic_get_qos. The operation DDS_Publisher_copy_from_topic_qos can be used to merge the DDS_DataWriter default QoS policies with the corresponding ones on the DDS_Topic. The resulting QoS can then be used to create a new DDS_DataWriter, or set its QoS.
This operation does not check the resulting DDS_DataWriterQos for consistency. This is because the 'merged' DDS_DataWriterQos may not be the final one, as the application can still modify some policies prior to applying the policies to the DDS_DataWriter.
| self | <<in>> Cannot be NULL. |
| a_datawriter_qos | <<inout>> DDS_DataWriterQos to be filled-up. Cannot be NULL. |
| a_topic_qos | <<in>> DDS_TopicQos to be merged with DDS_DataWriterQos. Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_set_qos | ( | DDS_Publisher * | self, |
| const struct DDS_PublisherQos * | qos | ||
| ) |
Sets the publisher QoS.
This operation modifies the QoS of the DDS_Publisher.
The DDS_PublisherQos::group_data, DDS_PublisherQos::partition and DDS_PublisherQos::entity_factory can be changed. The other policies are immutable.
| self | <<in>> Cannot be NULL. |
| qos | <<in>> DDS_PublisherQos to be set to. Policies must be consistent. Immutable policies cannot be changed after DDS_Publisher is enabled. The special value DDS_PUBLISHER_QOS_DEFAULT can be used to indicate that the QoS of the DDS_Publisher should be changed to match the current default DDS_PublisherQos set in the DDS_DomainParticipant. Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_set_qos_with_profile | ( | DDS_Publisher * | self, |
| const char * | library_name, | ||
| const char * | profile_name | ||
| ) |
<<extension>> Change the QoS of this publisher using the input XML QoS profile.
This operation modifies the QoS of the DDS_Publisher.
The DDS_PublisherQos::group_data, DDS_PublisherQos::partition and DDS_PublisherQos::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 Connext will use the default library (see DDS_Publisher_set_default_library). |
| profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see DDS_Publisher_set_default_profile). |
| DDS_ReturnCode_t DDS_Publisher_get_qos | ( | DDS_Publisher * | self, |
| struct DDS_PublisherQos * | qos | ||
| ) |
Gets the publisher QoS.
This function may potentially allocate memory depending on the sequences contained in some QoS policies.
| self | <<in>> Cannot be NULL. |
| qos | <<in>> DDS_PublisherQos to be filled in. Cannot be NULL. |
| const char* DDS_Publisher_get_default_library | ( | DDS_Publisher * | self | ) |
<<extension>> Gets the default XML library associated with a DDS_Publisher.
| self | <<in>> Cannot be NULL. |
| const char* DDS_Publisher_get_default_profile | ( | DDS_Publisher * | self | ) |
<<extension>> Gets the default XML profile associated with a DDS_Publisher.
| self | <<in>> Cannot be NULL. |
| const char* DDS_Publisher_get_default_profile_library | ( | DDS_Publisher * | self | ) |
<<extension>> Gets the library where the default XML QoS profile is contained for a DDS_Publisher.
The default profile library is automatically set when DDS_Publisher_set_default_profile is called.
This library can be different than the DDS_Publisher default library (see DDS_Publisher_get_default_library).
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_set_listener | ( | DDS_Publisher * | self, |
| const struct DDS_PublisherListener * | l, | ||
| DDS_StatusMask | mask | ||
| ) |
Sets the publisher listener.
| self | <<in>> Cannot be NULL. |
| l | <<in>> DDS_PublisherListener to set to. |
| mask | <<in>> DDS_StatusMask associated with the DDS_PublisherListener. The callback function on the listener cannot be NULL if the corresponding status is turned on in the mask. |
| struct DDS_PublisherListener DDS_Publisher_get_listener | ( | DDS_Publisher * | self | ) |
Get the publisher listener.
| self | <<in>> Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_get_listenerX | ( | DDS_Publisher * | self, |
| struct DDS_PublisherListener * | listener | ||
| ) |
<<extension>> Get the publisher listener.
An alternative form of get_listener that fills in an existing listener structure rather than returning one on the stack.
| self | <<in>> Cannot be NULL. |
| listener | <<inout>> DDS_PublisherListener structure to be filled up. Cannot be NULL. |
| DDS_ReturnCode_t DDS_Publisher_wait_for_acknowledgments | ( | DDS_Publisher * | self, |
| const struct DDS_Duration_t * | max_wait | ||
| ) |
Blocks the calling thread until all data written by the Publisher's reliable DataWriters is acknowledged, or until timeout expires.
This operation blocks the calling thread until either all data written by the reliable DataWriters entities is acknowledged by (a) all reliable DDS_DataReader entities that are matched and alive and (b) by all required subscriptions, or until the duration specified by the max_wait parameter elapses, whichever happens first. A successful completion indicates that all the samples written have been acknowledged; a timeout indicates that max_wait elapsed before all the data was acknowledged.
Note that if a thread is blocked in the call to this operation on a DDS_Publisher and a different thread writes new samples on any of the reliable DataWriters that belong to this Publisher, the new samples must be acknowledged before unblocking the thread that is waiting on this operation.
If none of the DDS_DataWriter instances have DDS_ReliabilityQosPolicy kind set to RELIABLE, the operation will complete successfully.
| self | <<in>> Cannot be NULL. |
| max_wait | <<in>> Specifies maximum time to wait for acknowledgements DDS_Duration_t . |
| DDS_ReturnCode_t DDS_Publisher_wait_for_asynchronous_publishing | ( | DDS_Publisher * | self, |
| const struct DDS_Duration_t * | max_wait | ||
| ) |
<<extension>> Blocks the calling thread until asynchronous sending is complete.
This operation blocks the calling thread (up to max_wait) until all data written by the asynchronous DDS_DataWriter entities is sent and acknowledged (if reliable) by all matched DDS_DataReader entities. A successful completion indicates that all the samples written have been sent and acknowledged where applicable; if it times out, this indicates that max_wait elapsed before all the data was sent and/or acknowledged.
In other words, this guarantees that sending to best effort DDS_DataReader is complete in addition to what DDS_Publisher_wait_for_acknowledgments provides.
If none of the DDS_DataWriter instances have DDS_PublishModeQosPolicy::kind set to DDS_ASYNCHRONOUS_PUBLISH_MODE_QOS, the operation will complete immediately , with DDS_RETCODE_OK.
| self | <<in>> Cannot be NULL. |
| max_wait | <<in>> Specifies maximum time to wait for acknowledgements DDS_Duration_t. |
| DDS_DataWriter* DDS_Publisher_lookup_datawriter_by_name | ( | DDS_Publisher * | self, |
| const char * | datawriter_name | ||
| ) |
<<extension>> Retrieves a DDS_DataWriter contained within the DDS_Publisher the DDS_DataWriter entity name.
Every DDS_DataWriter in the system has an entity name which is configured and stored in the <<extension>> EntityName policy, ENTITY_NAME.
This operation retrieves the DDS_DataWriter within the DDS_Publisher whose name matches the one specified. If there are several DDS_DataWriter with the same name within the DDS_Publisher, the operation returns the first matching occurrence.
| self | <<in>> Cannot be NULL. |
| datawriter_name | <<in>> Entity name of the DDS_DataWriter. |
| const struct DDS_DataWriterQos* DDS_DATAWRITER_QOS_PRINT_ALL |
Special value which can be supplied to DDS_DataWriterQos_to_string_w_params indicating that all of the QoS should be printed.
The DDS_DataWriterQos_to_string_w_params API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the DDS_DATAWRITER_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.
Note that there are some QoS policies and fields which are not intended for public use. Even when DDS_DATAWRITER_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the DDS_QosPrintFormat structure.
This value should only be used as the base parameter to the DDS_DataWriterQos_to_string_w_params API.
| const struct DDS_DataWriterQos DDS_DATAWRITER_QOS_DEFAULT |
Special value for creating DDS_DataWriter with default QoS.
When used in DDS_Publisher_create_datawriter, this special value is used to indicate that the DDS_DataWriter should be created with the default DDS_DataWriter QoS by means of the operation get_default_datawriter_qos and using the resulting QoS to create the DDS_DataWriter.
When used in DDS_Publisher_set_default_datawriter_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_Publisher_set_default_datawriter_qos operation had never been called.
When used in DDS_DataWriter_set_qos, this special value is used to indicate that the QoS of the DDS_DataWriter should be changed to match the current defualt QoS set in the DDS_Publisher that the DDS_DataWriter belongs to.
| const struct DDS_DataWriterQos DDS_DATAWRITER_QOS_USE_TOPIC_QOS |
Special value for creating DDS_DataWriter with a combination of the default DDS_DataWriterQos and the DDS_TopicQos.
The use of this value is equivalent to the application obtaining the default DDS_DataWriterQos and the DDS_TopicQos (by means of the operation DDS_Topic_get_qos) and then combining these two QoS using the operation DDS_Publisher_copy_from_topic_qos whereby any policy that is set on the DDS_TopicQos "overrides" the corresponding policy on the default QoS. The resulting QoS is then applied to the creation of the DDS_DataWriter.
This value should only be used in DDS_Publisher_create_datawriter.