dds::pub::SuspendedPublication Class Reference

Class for RAII way of suspending/resuming publication. More...

#include "SuspendedPublication.hpp"

Inherits dds::core::Value< D >.

Public Member Functions
	SuspendedPublication (const dds::pub::Publisher &pub)
	~SuspendedPublication ()
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const
void	resume ()

Detailed Description

Class for RAII way of suspending/resuming publication.

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

When a Suspended publication is started, it must be matched by a corresponding call to SuspendedPublication::resume() or the destruction of the SuspendedPublication object (which is an implicit resume), indicating that the set of modifications has completed. If the Publisher is deleted before the resume, any suspended updates yet to be published will be discarded.

This object suspends the publication of all DataWriter objects contained by the given Publisher. The data written, disposed or unregistered by a DataWriter is stored in the history buffer of the DataWriter and therefore, depending on its QoS settings, the following operations may block (see the operation descriptions for more information):

• dds::pub::DataWriter.write (and its overloaded counterparts).
• dds::pub::DataWriter.operator<< (and its overloaded counterparts).
• dds::pub::DataWriter.unregister_instance (and its overloaded counterparts).
• dds::pub::DataWriter.dispose_instance (and its overloaded counterparts).

See also

Publication

dds::pub::Publisher

Definition at line 66 of file SuspendedPublication.hpp.

Constructor & Destructor Documentation

SuspendedPublication()

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

explicit

Creating a SuspendedPublication object, which will suspend the dissemination of the publications by all contained DataWriter objects of the given Publisher.

Parameters

pub	The publisher to supsend publications on.

Exceptions

dds::core::Error	An internal error has occurred.
dds::core::AlreadyClosedError	The Publisher has already been closed.
dds::core::NotEnabledError	The Publisher has not yet been enabled.
dds::core::OutOfResourcesError	The Data Distribution Service ran out of resources to complete this operation.
dds::core::NullReferenceError	The Publisher was not properly created and references to dds::core::null.

~SuspendedPublication()

dds::pub::SuspendedPublication::~SuspendedPublication

(

)

The destruction of the SuspendedPublication will implicitly resume the publication if not already resumed by a call to resume().

All data held in the history buffer of the DataWriter's is actively published to the consumers. When the operation returns all DataWriter's have resumed the publication of suspended updates.

When there is a problem with which resume() would normally throw an exception, then that exception is swallowed. Errors can be found in the logs.

Member Function Documentation

operator!=()

template<typename D >

bool dds::core::Value< D >::operator!= ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if not equal

operator->() [1/2]

template<typename D >

D* dds::core::Value< D >::operator-> ( )

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

operator->() [2/2]

template<typename D >

const D* dds::core::Value< D >::operator-> ( ) const

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

operator==()

template<typename D >

bool dds::core::Value< D >::operator== ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if equal

resume()

void dds::pub::SuspendedPublication::resume

(

)

This operation will explicitly resume the publication of all DataWriter objects contained by the given Publisher at construction.

All data held in the history buffer of the DataWriter's is actively published to the consumers. When the operation returns all DataWriter's have resumed the publication of suspended updates.

If the Publisher already resumed its publication (by a call to this very operation), then a call to this operation will have no effect.

Exceptions

dds::core::Error	An internal error has occurred.
dds::core::AlreadyClosedError	The Publisher has already been closed.
dds::core::NotEnabledError	The Publisher has not yet been enabled.
dds::core::OutOfResourcesError	The Data Distribution Service ran out of resources to complete this operation.
dds::core::NullReferenceError	The Publisher was not properly created and references to dds::core::null.

---

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

• dds/pub/SuspendedPublication.hpp