dds::pub::TSuspendedPublication< DELEGATE > Class Template Reference

#include <TSuspendedPublication.hpp>

Inheritance diagram for dds::pub::TSuspendedPublication< DELEGATE >:

Public Member Functions
	TSuspendedPublication (const dds::pub::Publisher &pub)
	~SuspendedPublication ()
void	resume ()
Public Member Functions inherited from dds::core::Value< DELEGATE >
	Value (const ARG &arg)
	Value (const ARG1 &arg1, const ARG2 &arg2)
	Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3)
	Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3, const ARG4 &arg4)
	Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3, const ARG4 &arg4, const ARG5 &arg5)
	Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3, const ARG4 &arg4, const ARG5 &arg5, const ARG6 &arg6)
	~Value ()
const DELEGATE &	delegate () const
DELEGATE &	delegate ()
	operator const DELEGATE & () const
	operator DELEGATE & ()
bool	operator!= (const Value &other) const
const DELEGATE *	operator-> () const
DELEGATE *	operator-> ()
Value &	operator= (const Value &other)
bool	operator== (const Value &other) const

Additional Inherited Members
Protected Member Functions inherited from dds::core::Value< DELEGATE >
	Value ()
	Value (const Value &p)
Protected Attributes inherited from dds::core::Value< DELEGATE >
DELEGATE	d_

Detailed Description

template<typename DELEGATE>
class dds::pub::TSuspendedPublication< DELEGATE >

Definition at line 32 of file TSuspendedPublication.hpp.

Constructor & Destructor Documentation

template<typename DELEGATE >

dds::pub::TSuspendedPublication< DELEGATE >::TSuspendedPublication ( const dds::pub::Publisher &  pub )

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.

template<typename DELEGATE >

dds::pub::TSuspendedPublication< DELEGATE >::~SuspendedPublication

(

)

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.

Member Function Documentation

template<typename DELEGATE >

void dds::pub::TSuspendedPublication< DELEGATE >::resume

(

)

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.

---

The documentation for this class was generated from the following file:

• src/hpp/dds/pub/TSuspendedPublication.hpp