RTI Connext Modern C++ API  Version 5.3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
dds::pub::SuspendedPublication Class Reference

<<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()
 

Detailed Description

<<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.

Exceptions
Oneof the Standard Exceptions or dds::core::NotEnabledError.
See Also
rti::pub::FlowController
rti::pub::FlowController::trigger_flow
FlowController::ON_DEMAND_NAME
rti::core::policy::PublishMode
See Also
DataWriter Use Cases
Entity Use Cases

Constructor & Destructor Documentation

dds::pub::SuspendedPublication::SuspendedPublication ( const dds::pub::Publisher pub)
inlineexplicit

Suspends the publications of the publisher.

dds::pub::SuspendedPublication::~SuspendedPublication ( )
inline

Calls resume()

Member Function Documentation

void dds::pub::SuspendedPublication::resume ( )
inline

Indicates that the application has completed these changes.


RTI Connext Modern C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc