RTI Connext Modern C++ API Version 7.2.0

Contains the parameters for creating a rti::request::Replier. More...

#include <ReplierParams.hpp>

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

Public Member Functions

 ReplierParams (dds::domain::DomainParticipant participant)
 Creates a ReplierParams with the parameters that a Replier always needs. More...
 
ReplierParamsservice_name (const std::string &name)
 The service name the Replier offers and Requesters use to match. More...
 
ReplierParamsrequest_topic_name (const std::string &name)
 Sets a specific request topic name. More...
 
ReplierParamsreply_topic_name (const std::string &name)
 Sets a specific reply topic name. More...
 
ReplierParamsdatawriter_qos (const dds::core::optional< dds::pub::qos::DataWriterQos > &qos)
 Sets the quality of service of the reply DataWriter. More...
 
ReplierParamsdatareader_qos (const dds::core::optional< dds::sub::qos::DataReaderQos > &qos)
 Sets the quality of service of the request DataReader. More...
 
ReplierParamspublisher (dds::pub::Publisher publisher)
 Sets a specific Publisher. More...
 
ReplierParamssubscriber (dds::sub::Subscriber subscriber)
 Sets a specific Subscriber. More...
 
ReplierParamsrequest_type (const dds::core::optional< dds::core::xtypes::DynamicType > &type)
 The request type, when DynamicData is used. More...
 
ReplierParamsreply_type (const dds::core::optional< dds::core::xtypes::DynamicType > &type)
 The reply type, when DynamicData is used. More...
 

Detailed Description

Contains the parameters for creating a rti::request::Replier.

See also
RequesterParams

Constructor & Destructor Documentation

◆ ReplierParams()

rti::request::ReplierParams::ReplierParams ( dds::domain::DomainParticipant  participant)
inlineexplicit

Creates a ReplierParams with the parameters that a Replier always needs.

In addition to the participant , a Replier needs either:

When dds::core::xtypes::DynamicData is used, ReplierParams::request_type and/or ReplierParams::reply_type are required as well.

The other parameters are optional.

Parameters
participantThe DomainParticipant that this replier uses to join a domain.

Member Function Documentation

◆ service_name()

ReplierParams & rti::request::ReplierParams::service_name ( const std::string &  name)

The service name the Replier offers and Requesters use to match.

See also
RequesterParams::service_name

◆ request_topic_name()

ReplierParams & rti::request::ReplierParams::request_topic_name ( const std::string &  name)

Sets a specific request topic name.

The specified topic name will be used, instead of allowing a topic name to be generated based on the ReplierParams::service_name. If that topic already exists, it will be reused. This is useful to have the Replier use a dds::topic::ContentFilteredTopic to receive only certain requests.

◆ reply_topic_name()

ReplierParams & rti::request::ReplierParams::reply_topic_name ( const std::string &  name)

Sets a specific reply topic name.

The specified topic name will be used, instead of allowing a topic name to be generated based on c the ReplierParams::service_name. If that topic already exists, it will be reused.

◆ datawriter_qos()

ReplierParams & rti::request::ReplierParams::datawriter_qos ( const dds::core::optional< dds::pub::qos::DataWriterQos > &  qos)

Sets the quality of service of the reply DataWriter.

See also
dds::core::QosProvider to access Qos profiles.

◆ datareader_qos()

ReplierParams & rti::request::ReplierParams::datareader_qos ( const dds::core::optional< dds::sub::qos::DataReaderQos > &  qos)

Sets the quality of service of the request DataReader.

See also
dds::core::QosProvider to access Qos profiles.

◆ publisher()

ReplierParams & rti::request::ReplierParams::publisher ( dds::pub::Publisher  publisher)

Sets a specific Publisher.

See also
RequesterParams::publisher

◆ subscriber()

ReplierParams & rti::request::ReplierParams::subscriber ( dds::sub::Subscriber  subscriber)

Sets a specific Subscriber.

See also
RequesterParams::subscriber

◆ request_type()

ReplierParams & rti::request::ReplierParams::request_type ( const dds::core::optional< dds::core::xtypes::DynamicType > &  type)

The request type, when DynamicData is used.

This is required when the Replier RequestType is dds::core::xtypes::DynamicData. Otherwise this is ignored.

◆ reply_type()

ReplierParams & rti::request::ReplierParams::reply_type ( const dds::core::optional< dds::core::xtypes::DynamicType > &  type)

The reply type, when DynamicData is used.

This is required when the Replier ReplyType is dds::core::xtypes::DynamicData. Otherwise this is ignored.