RTI Connext Modern C++ API
Version 5.3.1
|
<<value-type>> Indicates that the application is about to make multiple modifications using several dds::pub::DataWriter's belonging to the same dds::pub::Publisher More...
#include <dds/pub/SuspendedPublication.hpp>
Public Member Functions | |
SuspendedPublication (const dds::pub::Publisher &pub) | |
Suspends the publications of the publisher. | |
void | resume () |
Indicates that the application has completed these changes. | |
~SuspendedPublication () | |
Calls resume() | |
<<value-type>> Indicates that the application is about to make multiple modifications using several dds::pub::DataWriter's belonging to the same dds::pub::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::pub::SuspendedPublication::resume() indicating that the set of modifications has completed.
If the dds::pub::Publisher is deleted before dds::pub::SuspendedPublication::resume() 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 rti::pub::FlowController, rti::core::policy::PublishModeKind_def::ASYNCHRONOUS dds::pub::DataWriter instances allow the user even finer control of traffic shaping and sample coalescing.
One | of the Standard Exceptions or dds::core::NotEnabledError. |
|
inlineexplicit |
Suspends the publications of the publisher.
|
inline |
Calls resume()
|
inline |
Indicates that the application has completed these changes.