#include <TSubscriber.hpp>

Inheritance diagram for dds::sub::TSubscriber< DELEGATE >:

Public Types
typedef dds::sub::SubscriberListener	Listener

Public Member Functions
	TSubscriber (const ::dds::domain::DomainParticipant &dp)

	TSubscriber (const ::dds::domain::DomainParticipant &dp, const dds::sub::qos::SubscriberQos &qos, dds::sub::SubscriberListener *listener=NULL, const dds::core::status::StatusMask &mask=dds::core::status::StatusMask::all())

	~TSubscriber ()

dds::sub::qos::DataReaderQos	default_datareader_qos () const

TSubscriber &	default_datareader_qos (const dds::sub::qos::DataReaderQos &qos) const

void	listener (Listener *, const dds::core::status::StatusMask &event_mask)

Listener *	listener () const

void	notify_datareaders ()

const dds::domain::DomainParticipant &	participant () const

const dds::sub::qos::SubscriberQos &	qos () const

void	qos (const dds::sub::qos::SubscriberQos &the_qos)

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 >
Reference &	operator= (const Reference< D > &that)

template<typename R >
Reference &	operator= (const R &rhs)

Reference &	operator= (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::sub::TSubscriber< DELEGATE >

Definition at line 35 of file TSubscriber.hpp.

Member Typedef Documentation

template<typename DELEGATE >

typedef dds::sub::SubscriberListener dds::sub::TSubscriber< DELEGATE >::Listener

Definition at line 40 of file TSubscriber.hpp.

Constructor & Destructor Documentation

template<typename DELEGATE >

dds::sub::TSubscriber< DELEGATE >::TSubscriber ( const ::dds::domain::DomainParticipant & dp )

Create a Subscriber attached to the given domain participant. The subscriber QoS will be set to the default as provided by the domain participant.

Parameters

dp	the domain participant that will own this subscriber.

template<typename DELEGATE >

dds::sub::TSubscriber< DELEGATE >::TSubscriber	(	const ::dds::domain::DomainParticipant &	dp,
		const dds::sub::qos::SubscriberQos &	qos,
		dds::sub::SubscriberListener *	listener = `NULL`,
		const dds::core::status::StatusMask &	mask = `dds::core::status::StatusMask::all()`
	)

Create a Subscriber attached to the given domain participant.

Parameters

dp	the domain participant that will own this subscriber.
qos	the subscriber qos
listenr	the subscriber listener.
mask	the listener event mask.

template<typename DELEGATE >

dds::sub::TSubscriber< DELEGATE >::~TSubscriber ( )

Member Function Documentation

template<typename DELEGATE >

dds::sub::qos::DataReaderQos dds::sub::TSubscriber< DELEGATE >::default_datareader_qos ( ) const

Get the default DataReader QoS.

template<typename DELEGATE >

TSubscriber& dds::sub::TSubscriber< DELEGATE >::default_datareader_qos ( const dds::sub::qos::DataReaderQos & qos ) const

Set the default DataReader QoS.

Parameters

qos	the default `DataReader` QoS.

template<typename DELEGATE >

void dds::sub::TSubscriber< DELEGATE >::listener	(	Listener *	,
		const dds::core::status::StatusMask &	event_mask
	)

Attach a listener to this.

Parameters

listener	the listener
event_mask	the event mask for the listener.

template<typename DELEGATE >

Listener* dds::sub::TSubscriber< DELEGATE >::listener ( ) const

Get the Subscriber listener.

template<typename DELEGATE >

void dds::sub::TSubscriber< DELEGATE >::notify_datareaders ( )

This operation invokes the operation on_data_available on the DataReaderListener objects attached to contained DataReader entities with a DATA_AVAILABLE status that is considered changed as described in Section 7.1.4.2.2, Changes in Read Communication Statuses.

template<typename DELEGATE >

const dds::domain::DomainParticipant& dds::sub::TSubscriber< DELEGATE >::participant ( ) const

Return the DomainParticipant that owns this Subscriber.

template<typename DELEGATE >

const dds::sub::qos::SubscriberQos& dds::sub::TSubscriber< DELEGATE >::qos ( ) const

Get the Subscriber QoS.

template<typename DELEGATE >

void dds::sub::TSubscriber< DELEGATE >::qos ( const dds::sub::qos::SubscriberQos & the_qos )

Set the Subscriber QoS.

Parameters

qos	the new QoS.

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

src/hpp/dds/sub/TSubscriber.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename DELEGATE> class dds::sub::TSubscriber< DELEGATE >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename DELEGATE>
class dds::sub::TSubscriber< DELEGATE >