rti::queuing::QueueRequesterParams Class Reference

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

#include <rti/queuing/QueueParams.hpp>

Inheritance diagram for rti::queuing::QueueRequesterParams:

Public Member Functions
	QueueRequesterParams (dds::domain::DomainParticipant participant)
	Creates a QueueRequesterParams object with the participant set.
QueueRequesterParams &	enable_availability (const bool enable)
	Indicates whether the availability channel is enabled with the reply SharedReaderQueue.
QueueRequesterParams &	enable_sample_replication (const bool enable)
	Causes the QueueRequester to write all the requests with the dds::sub::SampleInfo::flag including the bit SampleFlagBits::REPLICATE_SAMPLE.
QueueRequesterParams &	enable_wait_for_ack (const bool enable)
	Enables Queuing Service's 'Acknowledgment Management' feature for requests.
Public Member Functions inherited from rti::queuing::QueueEntityParams< QueueRequesterParams >
QueueRequesterParams &	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.
QueueRequesterParams &	shared_subscriber_name (const std::string &name)
	Sets the SharedSubscriber name associated with the SharedReaderQueues.
QueueRequesterParams &	entity_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 QueueRequester.

Constructor & Destructor Documentation

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

participant

The dds::domain::DomainParticipant a QueueRequester uses to join a domain.

Member Function Documentation

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

inline

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

See Also

QueueConsumerParams::enable_availability.

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

inline

Causes the QueueRequester to write all the requests with the dds::sub::SampleInfo::flag including the bit SampleFlagBits::REPLICATE_SAMPLE.

See Also

QueueProducerParams::enable_sample_replication

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

inline

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

See Also

QueueProducerParams::enable_wait_for_ack