RTI Connext Modern C++ API  Version 5.3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::queuing::QueueProducerListener< T > Class Template Referenceabstract

Called when certain events occur in a QueueProducer. More...

#include <rti/queuing/QueueProducerListener.hpp>

Inheritance diagram for rti::queuing::QueueProducerListener< T >:
rti::queuing::NoOpQueueProducerListener< T >

Public Member Functions

virtual void on_sample_acknowledged (QueueProducer< T > &producer, const rti::pub::AcknowledgmentInfo &info)=0
 User callback.
 
virtual void on_shared_reader_queue_matched (QueueProducer< T > &producer, const dds::core::status::PublicationMatchedStatus &status)=0
 User callback.
 

Detailed Description

template<typename T>
class rti::queuing::QueueProducerListener< T >

Called when certain events occur in a QueueProducer.

A QueueProducer listener is a way to implement a callback that will be invoked when certain events happen. It is an optional parameter in QueueProducerParams.

You can use this listener to receive notification when:

  • A sample previously sent by a QueueProducer has been acknowledged by Queuing Service.
  • There are SharedReaderQueue matching events.
See Also
QueueProducer::QueueProducer()

Member Function Documentation

template<typename T>
virtual void rti::queuing::QueueProducerListener< T >::on_sample_acknowledged ( QueueProducer< T > &  producer,
const rti::pub::AcknowledgmentInfo info 
)
pure virtual

User callback.

This callback is invoked whenever Queuing Service acknowledges a sample sent by the QueueProducer.

See Also
AcknowledgmentInfo

Implemented in rti::queuing::NoOpQueueProducerListener< T >, rti::queuing::NoOpQueueProducerListener< TReq >, and rti::queuing::NoOpQueueProducerListener< TRep >.

template<typename T>
virtual void rti::queuing::QueueProducerListener< T >::on_shared_reader_queue_matched ( QueueProducer< T > &  producer,
const dds::core::status::PublicationMatchedStatus status 
)
pure virtual

User callback.

This callback is invoked whenever a new SharedReaderQueue hosted by Queuing Service has matched the QueueProducer, or if an existing matching SharedReaderQueue is disposed.

See Also
dds::core::status::PublicationMatchedStatus
dds::pub::DataWriterListener::on_publication_matched

Implemented in rti::queuing::NoOpQueueProducerListener< T >, rti::queuing::NoOpQueueProducerListener< TReq >, and rti::queuing::NoOpQueueProducerListener< TRep >.


RTI Connext Modern C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc