RTI Connext Modern C++ API  Version 6.0.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::queuing::QueueEntityParams< ActualEntity > Class Template Reference

A parent class for all queue parameter classes. More...

#include <rti/queuing/QueueParams.hpp>

Inherits rti::request::detail::EntityParamsWithSetters< ActualEntity >.

Public Member Functions

ActualEntity & 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.
 
ActualEntity & shared_subscriber_name (const std::string &name)
 Sets the SharedSubscriber name associated with the SharedReaderQueues.
 
ActualEntity & 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 & request_type (const dds::core::optional< dds::core::xtypes::DynamicType > &type)
 
ActualEntity & reply_type (const dds::core::optional< dds::core::xtypes::DynamicType > &type)
 
ActualEntity & publisher (dds::pub::Publisher publisher)
 
ActualEntity & subscriber (dds::sub::Subscriber subscriber)
 

Detailed Description

template<typename ActualEntity>
class rti::queuing::QueueEntityParams< ActualEntity >

A parent class for all queue parameter classes.

Member Function Documentation

template<typename ActualEntity>
ActualEntity& rti::queuing::QueueEntityParams< ActualEntity >::qos_profile ( const std::string &  qos_library_name,
const std::string &  qos_profile_name 
)
inline

Specifies an XML QoS profile that will be used to configure the quality of service of the DDS entities created.

This includes the DataReader and DataWriter used to send and receive samples from a SharedReaderQueue.

Alternatively, you can set the DataReader and DataWriter QoS using datareader_qos() and datawriter_qos() methods. If you set the DataReader QoS or the DataWriter QoS the provided values will be used instead of the QoS specified in the XML qos profile.

Parameters
qos_library_nameThe name of the QoS library
qos_profile_nameThe name of the QoS profile inside the QoS library
template<typename ActualEntity>
ActualEntity& rti::queuing::QueueEntityParams< ActualEntity >::shared_subscriber_name ( const std::string &  name)
inline

Sets the SharedSubscriber name associated with the SharedReaderQueues.

template<typename ActualEntity>
ActualEntity& rti::queuing::QueueEntityParams< ActualEntity >::entity_name ( const std::string &  name)
inline

Sets the name of the QueueEntity.

The name of the QueueEntity is used along with the topic name to generate the QueueEntity's GUID. The entity name is used along with the topic name to generate a Guid. By default, entity name is null which means that the entity Guid is randomly generated.


RTI Connext Modern C++ API Version 6.0.1 Copyright © Sat Nov 23 2019 Real-Time Innovations, Inc