Contains the parameters for creating a QueueConsumer. More...
#include <rti/queuing/QueueParams.hpp>
Public Member Functions | |
| QueueConsumerParams (dds::domain::DomainParticipant participant) | |
| Creates a QueueConsumerParams object with the participant set. More... | |
| QueueConsumerParams & | enable_availability (bool enable) |
| Indicates whether the availability channel is enabled for a QueueConsumer. More... | |
 Public Member Functions inherited from rti::queuing::QueueEntityParams< QueueConsumerParams > | |
| QueueConsumerParams & | qos_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. More... | |
| QueueConsumerParams & | shared_subscriber_name (const std::string &name) |
| Sets the SharedSubscriber name associated with the SharedReaderQueues. More... | |
| QueueConsumerParams & | entity_name (const std::string &name) |
| Sets the name of the QueueEntity. More... | |
Detailed Description
Contains the parameters for creating a QueueConsumer.
Constructor & Destructor Documentation
◆ QueueConsumerParams()
|
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
-
participant The dds::domain::DomainParticipant a QueueConsumer uses to join a domain.
Member Function Documentation
◆ enable_availability()
|
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)
References rti::util::network_capture::enable().