RTI Connext Traditional C++ API  Version 5.3.1
 All Classes Functions Variables Typedefs Enumerations Enumerator Groups Pages
connext::ReplierParams< TReq, TRep > Class Template Reference

Contains the parameters for creating a connext::Replier. More...

Inherits connext::details::EntityParams.

Public Member Functions

 ReplierParams (DDS::DomainParticipant *participant)
 Creates a ReplierParams with the parameters that a Replier always needs.
 
ReplierParamsreplier_listener (ReplierListener< TReq, TRep > &listener)
 Sets a listener that is called when requests are available.
 
ReplierParamsservice_name (const std::string &service_name)
 The service name the Replier offers and Requesters use to match.
 
ReplierParamsrequest_topic_name (const std::string &req_topic)
 Sets a specific request topic name.
 
ReplierParamsreply_topic_name (const std::string &rep_topic)
 Sets a specific reply topic name.
 
ReplierParamsqos_profile (const std::string &qos_library_name, const std::string &qos_profile_name)
 Sets a QoS profile for the entities in this replier.
 
ReplierParamsdatawriter_qos (const DDS_DataWriterQos &qos)
 Sets the quality of service of the reply DataWriter.
 
ReplierParamsdatareader_qos (const DDS_DataReaderQos &qos)
 Sets the quality of service of the request DataReader.
 
ReplierParamspublisher (DDS::Publisher *publisher)
 Sets a specific Publisher.
 
ReplierParamssubscriber (DDS::Subscriber *subscriber)
 Sets a specific Subscriber.
 
ReplierParamsrequest_type_support (DDS::TypeSupport *type_support)
 Sets the type support for the request type.
 
ReplierParamsreply_type_support (DDS::TypeSupport *type_support)
 Sets the type support for the reply type.
 

Detailed Description

template<typename TReq, typename TRep>
class connext::ReplierParams< TReq, TRep >

Contains the parameters for creating a connext::Replier.

See Also
connext::RequesterParams

Constructor & Destructor Documentation

template<typename TReq , typename TRep >
connext::ReplierParams< TReq, TRep >::ReplierParams ( DDS::DomainParticipant participant)
inlineexplicit

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

In addition to the parameters this constructor takes, a Replier needs either:

The other parameters are optional.

Parameters
participantThe DomainParticipant that this replier uses to join a domain.
requestTypeSupportThe type support for type TReq
replyTypeSupportThe type support for type Trep

Member Function Documentation

template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::replier_listener ( ReplierListener< TReq, TRep > &  listener)
inline

Sets a listener that is called when requests are available.

See Also
connext::ReplierListener
template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::service_name ( const std::string &  service_name)
inline

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

See Also
connext::RequesterParams::service_name
template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::request_topic_name ( const std::string &  req_topic)
inline

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 service_name. If that topic already exists, it will be reused. This is useful to have the Replier use a DDSContentFilteredTopic to receive only certain requests.

template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::reply_topic_name ( const std::string &  rep_topic)
inline

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 service_name. If that topic already exists, it will be reused.

template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::qos_profile ( const std::string &  qos_library_name,
const std::string &  qos_profile_name 
)
inline

Sets a QoS profile for the entities in this replier.

Specifies the XML QoS profile that will be used to configure the quality of service for the Replier's underlying reply DataWriter and request DataReader.

Parameters
qos_library_nameThe name of the QoS library
qos_profile_nameThe name of the QoS profile inside the QoS library
See Also
connext::RequesterParams::qos_profile
Configuring Request-Reply QoS profiles
Configuring QoS Profiles with XML
template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::datawriter_qos ( const DDS_DataWriterQos qos)
inline

Sets the quality of service of the reply DataWriter.

See Also
qos_profile
template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::datareader_qos ( const DDS_DataReaderQos qos)
inline

Sets the quality of service of the request DataReader.

See Also
qos_profile
template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::publisher ( DDS::Publisher publisher)
inline

Sets a specific Publisher.

See Also
connext::RequesterParams::publisher
template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::subscriber ( DDS::Subscriber subscriber)
inline

Sets a specific Subscriber.

See Also
connext::RequesterParams::subscriber
template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::request_type_support ( DDS::TypeSupport type_support)
inline

Sets the type support for the request type.

This parameter is required when TReq is DDS_DynamicData.

In all other cases, this parameter is ignored and the singleton Reply<TReq, TRep>::RequestTypeSupport is used instead

See Also
DDSDynamicDataTypeSupport
template<typename TReq , typename TRep >
ReplierParams& connext::ReplierParams< TReq, TRep >::reply_type_support ( DDS::TypeSupport type_support)
inline

Sets the type support for the reply type.

This parameter is required when TRep is DDS_DynamicData.

In all other cases, this parameter is ignored and the singleton Reply<TReq, TRep>::RequestTypeSupport is used instead

See Also
DDSDynamicDataTypeSupport

RTI Connext Traditional C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc