RTI Connext Modern C++ API  Version 6.0.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::request::ReplierParams Class Reference

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.
 
ReplierParamsservice_name (const std::string &name)
 The service name the Replier offers and Requesters use to match.
 
ReplierParamsrequest_topic_name (const std::string &name)
 Sets a specific request topic name.
 
ReplierParamsreply_topic_name (const std::string &name)
 Sets a specific reply topic name.
 
ReplierParamsdatawriter_qos (const dds::core::optional< dds::pub::qos::DataWriterQos > &qos)
 Sets the quality of service of the reply DataWriter.
 
ReplierParamsdatareader_qos (const dds::core::optional< dds::sub::qos::DataReaderQos > &qos)
 Sets the quality of service of the request DataReader.
 
ReplierParamspublisher (dds::pub::Publisher publisher)
 Sets a specific Publisher.
 
ReplierParamssubscriber (dds::sub::Subscriber subscriber)
 Sets a specific Subscriber.
 
ReplierParamsrequest_type (const dds::core::optional< dds::core::xtypes::DynamicType > &type)
 The request type, when DynamicData is used.
 
ReplierParamsreply_type (const dds::core::optional< dds::core::xtypes::DynamicType > &type)
 The reply type, when DynamicData is used.
 
- 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

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

See Also
RequesterParams

Constructor & Destructor Documentation

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

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
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.

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.

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.
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.
ReplierParams& rti::request::ReplierParams::publisher ( dds::pub::Publisher  publisher)

Sets a specific Publisher.

See Also
RequesterParams::publisher
ReplierParams& rti::request::ReplierParams::subscriber ( dds::sub::Subscriber  subscriber)

Sets a specific Subscriber.

See Also
RequesterParams::subscriber
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.

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.


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