DDS-PSM-C++  1.0
ISO C++ API for OpenSplice DDS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Public Member Functions | List of all members
dds::pub::TPublisher< DELEGATE > Class Template Reference

#include <TPublisher.hpp>

Inheritance diagram for dds::pub::TPublisher< DELEGATE >:
Inheritance graph
[legend]

Public Types

typedef dds::pub::PublisherListener Listener
 

Public Member Functions

 TPublisher (const dds::domain::DomainParticipant &dp)
 
 TPublisher (const dds::domain::DomainParticipant &dp, const dds::pub::qos::PublisherQos &qos, dds::pub::PublisherListener *listener=NULL, const dds::core::status::StatusMask &mask=dds::core::status::StatusMask::all())
 
 ~TPublisher ()
 
TPublisheroperator<< (const dds::pub::qos::PublisherQos &the_qos)
 
TPublisheroperator>> (dds::pub::qos::PublisherQos &the_qos)
 
const dds::pub::qos::PublisherQos qos () const
 
void qos (const dds::pub::qos::PublisherQos &pqos)
 
- Public Member Functions inherited from dds::core::TEntity< DELEGATE >
 ~TEntity ()
 
void close ()
 
void enable ()
 
const dds::core::InstanceHandle instance_handle () const
 
void retain ()
 
const dds::core::status::StatusMask status_changes ()
 
- Public Member Functions inherited from dds::core::Reference< DELEGATE >
 Reference (dds::core::null_type &)
 
 Reference (const Reference &ref)
 
template<typename D >
 Reference (const Reference< D > &ref)
 
 Reference (DELEGATE_T *p)
 
 ~Reference ()
 
const DELEGATE_REF_T & delegate () const
 
DELEGATE_REF_T & delegate ()
 
bool is_nil () const
 
 operator const DELEGATE_REF_T & () const
 
 operator DELEGATE_REF_T () const
 
 operator DELEGATE_REF_T & ()
 
template<typename R >
bool operator!= (const R &ref) const
 
bool operator!= (const null_type nil) const
 
DELEGATE * operator-> ()
 
const DELEGATE * operator-> () const
 
template<typename D >
Referenceoperator= (const Reference< D > &that)
 
template<typename R >
Referenceoperator= (const R &rhs)
 
Referenceoperator= (const null_type)
 
template<typename R >
bool operator== (const R &ref) const
 
bool operator== (const null_type) const
 

Additional Inherited Members

- Protected Attributes inherited from dds::core::Reference< DELEGATE >
DELEGATE_REF_T impl_
 

Detailed Description

template<typename DELEGATE>
class dds::pub::TPublisher< 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 47 of file TPublisher.hpp.

Member Typedef Documentation

template<typename DELEGATE >
typedef dds::pub::PublisherListener dds::pub::TPublisher< DELEGATE >::Listener

Definition at line 49 of file TPublisher.hpp.

Constructor & Destructor Documentation

template<typename DELEGATE >
dds::pub::TPublisher< DELEGATE >::TPublisher ( const dds::domain::DomainParticipant dp)

Create a new Publisher.

Parameters
dpthe domain participant
template<typename DELEGATE >
dds::pub::TPublisher< DELEGATE >::TPublisher ( const dds::domain::DomainParticipant dp,
const dds::pub::qos::PublisherQos qos,
dds::pub::PublisherListener listener = NULL,
const dds::core::status::StatusMask mask = dds::core::status::StatusMask::all() 
)

Create a Publisher with the desired QoS policies and attaches to it the specified PublisherListener. If the specified QoS policies are not consistent, the operation will fail and an exception will be thrown.

Parameters
dpthe domain participant.
qosthe publisher qos policies.
listenerthe publisher listener
maskthe mask of events notified to the listener.
template<typename DELEGATE >
dds::pub::TPublisher< DELEGATE >::~TPublisher ( )

Member Function Documentation

template<typename DELEGATE >
TPublisher& dds::pub::TPublisher< DELEGATE >::operator<< ( const dds::pub::qos::PublisherQos the_qos)

Set the new qos policies for this publisher.

Parameters
pqosthe new publisher QoS
template<typename DELEGATE >
TPublisher& dds::pub::TPublisher< DELEGATE >::operator>> ( dds::pub::qos::PublisherQos the_qos)

Get the publisher qos policies.

template<typename DELEGATE >
const dds::pub::qos::PublisherQos dds::pub::TPublisher< DELEGATE >::qos ( ) const

Get the publisher qos policies.

template<typename DELEGATE >
void dds::pub::TPublisher< DELEGATE >::qos ( const dds::pub::qos::PublisherQos pqos)

Set the new qos policies for this publisher.

Parameters
pqosthe new publisher QoS

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