RTI Connext Modern C++ API  Version 5.3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::queuing::QueueConsumerParams Class Reference

Contains the parameters for creating a QueueConsumer. More...

#include <rti/queuing/QueueParams.hpp>

Inheritance diagram for rti::queuing::QueueConsumerParams:
rti::queuing::QueueEntityParams< QueueConsumerParams >

Public Member Functions

 QueueConsumerParams (dds::domain::DomainParticipant participant)
 Creates a QueueConsumerParams object with the participant set.
 
QueueConsumerParamsenable_availability (const bool enable)
 Indicates whether the availability channel is enabled for a QueueConsumer.
 
- Public Member Functions inherited from rti::queuing::QueueEntityParams< QueueConsumerParams >
QueueConsumerParamsqos_profile (const std::string &qos_library_name, const std::string &qos_profile_name)
 Specifies an XML QoS profile that will be used to configure the quality of service of the DDS entities created.
 
QueueConsumerParamsshared_subscriber_name (const std::string &name)
 Sets the SharedSubscriber name associated with the SharedReaderQueues.
 
QueueConsumerParamsentity_name (const std::string &name)
 Sets the name of the QueueEntity.
 
- Public Member Functions inherited from rti::request::detail::EntityParamsWithSetters< ActualEntity >
ActualEntity & service_name (const std::string &name)
 
ActualEntity & request_topic_name (const std::string &name)
 
ActualEntity & reply_topic_name (const std::string &name)
 
ActualEntity & datawriter_qos (const dds::core::optional< dds::pub::qos::DataWriterQos > &qos)
 
ActualEntity & datareader_qos (const dds::core::optional< dds::sub::qos::DataReaderQos > &qos)
 
ActualEntity & publisher (dds::pub::Publisher publisher)
 
ActualEntity & subscriber (dds::sub::Subscriber subscriber)
 

Detailed Description

Contains the parameters for creating a QueueConsumer.

Constructor & Destructor Documentation

rti::queuing::QueueConsumerParams::QueueConsumerParams ( dds::domain::DomainParticipant  participant)
inlineexplicit

Creates a QueueConsumerParams object with the participant set.

The rest of the parameters that can be set in a QueueConsumerParams object are optional.

Parameters
participantThe dds::domain::DomainParticipant a QueueConsumer uses to join a domain.

Member Function Documentation

QueueConsumerParams& rti::queuing::QueueConsumerParams::enable_availability ( const bool  enable)
inline

Indicates whether the availability channel is enabled for a QueueConsumer.

When this parameter is set to true, the QueueConsumer creates a DataWriter to report its availability to the SharedReaderQueue from which the QueueConsumer receives samples.

The QueueConsumer can send availability samples to the SharedReaderQueue using the method QueueConsumer::send_availability(ConsumerAvailabilityParams)

See Also
QueueConsumer::send_availability(ConsumerAvailabilityParams)

RTI Connext Modern C++ API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc