#include <SuspendedPublication.hpp>
Inheritance diagram for SuspendedPublication< DELEGATE >:
Public Member Functions | |
| SuspendedPublication (const dds::pub::Publisher &pub) | |
| SuspendedPublication (const SuspendedPublication &src) | |
| void | resume () |
| ~SuspendedPublication () | |
Detailed Description
template<typename DELEGATE>
class tdds::pub::SuspendedPublication< DELEGATE >
Definition at line 28 of file SuspendedPublication.hpp.
Constructor & Destructor Documentation
| SuspendedPublication | ( | const dds::pub::Publisher & | pub | ) | [inline, explicit] |
This operation indicates to the Service that the application is about to make multiple modifications using DataWriter objects belonging to the Publisher. It is a hint to the Service so it can optimize its performance by e.g., holding the dissemination of the modifications and then batching them. It is not required that the Service use this hint in any way. The use of this operation must be matched by a corresponding call to resume_publications indicating that the set of modifications has completed. If the Publisher is deleted before resume_publications is called, any suspended updates yet to be published will be discarded.
- Returns:
- true if publications were suspended. False if the method was called on an already suspended publisher.
Definition at line 45 of file SuspendedPublication.hpp.
| SuspendedPublication | ( | const SuspendedPublication< DELEGATE > & | src | ) |
| ~SuspendedPublication | ( | ) | [inline] |
This operation indicates to the Service that the application has completed the multiple changes initiated by the previous suspend_publications. This is a hint to the Service that can be used by a Service implementation to e.g., batch all the modifications made since the suspend_publications. The call to resume_publications must match a previous call to suspend_publications. Otherwise the operation will return the error PRECONDITION_NOT_MET.
Definition at line 72 of file SuspendedPublication.hpp.
Member Function Documentation
| void resume | ( | ) | [inline] |
This operation indicates to the Service that the application has completed the multiple changes initiated by the previous suspend_publications. This is a hint to the Service that can be used by a Service implementation to e.g., batch all the modifications made since the suspend_publications. The call to resume_publications must match a previous call to suspend_publications. Otherwise the operation will return the error PRECONDITION_NOT_MET.
Definition at line 59 of file SuspendedPublication.hpp.
The documentation for this class was generated from the following file:
- src/hpp/tdds/pub/SuspendedPublication.hpp
