Public Types | Public Member Functions

Publisher< DELEGATE > Class Template Reference

#include <Publisher.hpp>

Inheritance diagram for Publisher< DELEGATE >:

List of all members.

Public Types

typedef dds::pub::PublisherListener Listener
typedef
dds::core::cond::StatusCondition
< Publisher
StatusCondition
typedef DELEGATE DELEGATE_T
typedef
::dds::core::smart_ptr_traits
< DELEGATE >::ref_type 
DELEGATE_REF_T
typedef
::dds::core::smart_ptr_traits
< DELEGATE >::weak_ref_type 
DELEGATE_WEAK_REF_T
typedef tdds::core::Entity
< DELEGATE > 
BASE_T

Public Member Functions

template<typename T__ >
Publisheroperator= (const T__ &rhs)
 Publisher (DELEGATE_T *p)
 Publisher (const DELEGATE_REF_T &ref)
template<typename H__ >
 Publisher (const H__ &h)
 Publisher ()
 ~Publisher ()
const dds::pub::qos::PublisherQos qos () const
void qos (const dds::pub::qos::PublisherQos &the_qos)
Publisheroperator<< (const dds::pub::qos::PublisherQos &the_qos)
Publisheroperator>> (dds::pub::qos::PublisherQos &the_qos)
void listener (Listener *the_listener, const dds::core::status::StatusMask &event_mask)
Listenerlistener () const
StatusCondition status_condition () const
void wait_for_acknowledgments (const dds::core::Duration &timeout)

Detailed Description

template<typename DELEGATE>
class tdds::pub::Publisher< DELEGATE >

The Publisher acts on the behalf of one or several DataWriter objects that belong to it. When it is informed of a change to the data associated with one of its DataWriter objects, it decides when it is appropriate to actually send the data-update message. In making this decision, it considers any extra information that goes with the data (timestamp, writer, etc.) as well as the QoS of the Publisher and the DataWriter.

Definition at line 43 of file Publisher.hpp.


Member Typedef Documentation

typedef tdds::core::Entity< DELEGATE > BASE_T

Reimplemented from Entity< DELEGATE >.

Definition at line 48 of file Publisher.hpp.

typedef ::dds::core::smart_ptr_traits< DELEGATE >::ref_type DELEGATE_REF_T

Reimplemented from Entity< DELEGATE >.

Definition at line 48 of file Publisher.hpp.

typedef DELEGATE DELEGATE_T

Reimplemented from Entity< DELEGATE >.

Definition at line 48 of file Publisher.hpp.

typedef ::dds::core::smart_ptr_traits< DELEGATE >::weak_ref_type DELEGATE_WEAK_REF_T

Reimplemented from Entity< DELEGATE >.

Definition at line 48 of file Publisher.hpp.

Definition at line 45 of file Publisher.hpp.

Definition at line 46 of file Publisher.hpp.


Constructor & Destructor Documentation

Publisher ( DELEGATE_T p  )  [inline, explicit]

Definition at line 48 of file Publisher.hpp.

Publisher ( const DELEGATE_REF_T ref  )  [inline, explicit]

Definition at line 48 of file Publisher.hpp.

Publisher ( const H__ &  h  )  [inline]

Definition at line 48 of file Publisher.hpp.

Publisher (  )  [inline]

Definition at line 48 of file Publisher.hpp.

~Publisher (  )  [inline]

Definition at line 50 of file Publisher.hpp.


Member Function Documentation

void listener ( Listener the_listener,
const dds::core::status::StatusMask event_mask 
)
Listener* listener (  )  const
Publisher& operator<< ( const dds::pub::qos::PublisherQos the_qos  )  [inline]

Definition at line 63 of file Publisher.hpp.

Publisher& operator= ( const T__ &  rhs  )  [inline]

Reimplemented from Entity< DELEGATE >.

Definition at line 48 of file Publisher.hpp.

Publisher& operator>> ( dds::pub::qos::PublisherQos the_qos  )  [inline]

Definition at line 68 of file Publisher.hpp.

const dds::pub::qos::PublisherQos qos (  )  const [inline]

Definition at line 54 of file Publisher.hpp.

void qos ( const dds::pub::qos::PublisherQos the_qos  )  [inline]

Definition at line 59 of file Publisher.hpp.

StatusCondition status_condition (  )  const [inline]

This operation allows access to the StatusCondition (Section 7.1.2.1.9, “StatusCondition Class) associated with the Entity. The returned condition can then be added to a WaitSet (Section 7.1.2.1.6, WaitSet Class) so that the application can wait for specific status changes that affect the Entity.

Returns:
the status condition

Definition at line 88 of file Publisher.hpp.

void wait_for_acknowledgments ( const dds::core::Duration timeout  )  [inline]

This operation blocks the calling thread until either all data written by the reliable DataWriter entities is acknowledged by all matched reliable DataReader entities, or else the duration specified by the max_wait parameter elapses, whichever happens first. A normal return indicates that all the samples written have been acknowledged by all reliable matched data readers; A TimeoutError indicates that max_wait elapsed before all the data was acknowledged.

Definition at line 102 of file Publisher.hpp.


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