RTI Connext Modern C++ API  Version 6.1.0
rti::queuing::QueueRequesterParams Class Reference

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

#include <rti/queuing/QueueParams.hpp>

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

Public Member Functions

 QueueRequesterParams (dds::domain::DomainParticipant participant)
 Creates a QueueRequesterParams object with the participant set. More...
 
QueueRequesterParamsenable_availability (bool enable)
 Indicates whether the availability channel is enabled with the reply SharedReaderQueue. More...
 
QueueRequesterParamsenable_sample_replication (bool enable)
 Causes the QueueRequester to write all the requests with the dds::sub::SampleInfo::flag including the bit rti::core::SampleFlag::replicate. More...
 
QueueRequesterParamsenable_wait_for_ack (bool enable)
 Enables Queuing Service's 'Acknowledgment Management' feature for requests. More...
 
- Public Member Functions inherited from rti::queuing::QueueEntityParams< QueueRequesterParams >
QueueRequesterParamsqos_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...
 
QueueRequesterParamsshared_subscriber_name (const std::string &name)
 Sets the SharedSubscriber name associated with the SharedReaderQueues. More...
 
QueueRequesterParamsentity_name (const std::string &name)
 Sets the name of the QueueEntity. More...
 

Detailed Description

Contains the parameters for creating a QueueRequester.

Constructor & Destructor Documentation

◆ QueueRequesterParams()

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

Creates a QueueRequesterParams object with the participant set.

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

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

Member Function Documentation

◆ enable_availability()

QueueRequesterParams& rti::queuing::QueueRequesterParams::enable_availability ( bool  enable)
inline

Indicates whether the availability channel is enabled with the reply SharedReaderQueue.

See also
QueueConsumerParams::enable_availability.

References rti::util::network_capture::enable().

◆ enable_sample_replication()

QueueRequesterParams& rti::queuing::QueueRequesterParams::enable_sample_replication ( bool  enable)
inline

◆ enable_wait_for_ack()

QueueRequesterParams& rti::queuing::QueueRequesterParams::enable_wait_for_ack ( bool  enable)
inline

Enables Queuing Service's 'Acknowledgment Management' feature for requests.

See also
QueueProducerParams::enable_wait_for_ack

References rti::util::network_capture::enable().