CoreDX DDS C++ Reference Manual
|
Used to pass configuration parameters when constructing a Requester. More...
Public Member Functions | |
| RequesterParams () | |
| Default constructor. | |
| ~RequesterParams () | |
| Destructor. | |
| RequesterParams (const RequesterParams &other) | |
| Copy constructor. | |
| RequesterParams & | operator= (const RequesterParams &that) |
| Assignment operator. | |
| template<class TRep > | |
| RequesterParams & | simple_requester_listener (SimpleRequesterListener< TRep > *listener) |
| Assign the 'simple' listener that will be installed in the Requester. More... | |
| template<class TReq , class TRep > | |
| RequesterParams & | requester_listener (RequesterListener< TReq, TRep > *listener) |
| Assign the 'requester' listener that will be installed in the Requester. More... | |
| RequesterParams & | domain_participant (dds_entity_traits::DomainParticipant participant) |
| Assign the DomainParticipant to use. More... | |
| RequesterParams & | publisher (dds_entity_traits::Publisher publisher) |
| Assign the Publisher to use. More... | |
| RequesterParams & | subscriber (dds_entity_traits::Subscriber subscriber) |
| Assign the Subscriber to use. More... | |
| RequesterParams & | datawriter_qos (dds_entity_traits::DataWriterQos qos) |
| Assign the DataWriterQos to use. More... | |
| RequesterParams & | datareader_qos (dds_entity_traits::DataReaderQos qos) |
| Assign the DataReaderQos to use. More... | |
| RequesterParams & | service_name (const std::string &name) |
| Assign the service_name to use when creating the Request and Reply topic names. More... | |
| RequesterParams & | request_topic_name (const std::string &name) |
| Assign the 'request_topic_name' to use as the Request topic name. More... | |
| RequesterParams & | reply_topic_name (const std::string &name) |
| Assign the 'reply_topic_name'. More... | |
| dds_entity_traits::DomainParticipant | domain_participant () const |
| Access the DomainParticipant configured in this instance of RequesterParams. | |
| dds_entity_traits::Publisher | publisher () const |
| Access the Publisher configured in this instance of RequesterParams. | |
| dds_entity_traits::Subscriber | subscriber () const |
| Access the Subscriber configured in this instance of RequesterParams. | |
| dds_entity_traits::DataWriterQos | datawriter_qos () const |
| Access the DataWriterQos configured in this instance of RequesterParams. | |
| dds_entity_traits::DataReaderQos | datareader_qos () const |
| Access the DataReaderQos configured in this instance of RequesterParams. | |
| ListenerBase * | simple_requester_listener () const |
| Access the SimpleRequesterListener configured in this instance of RequesterParams. | |
| ListenerBase * | requester_listener () const |
| Access the RequesterListener configured in this instance of RequesterParams. | |
| std::string | service_name () const |
| Access the service_name configured in this instance of RequesterParams. | |
| std::string | request_topic_name () const |
| Access the request_topic_name configured in this instance of RequesterParams. | |
| std::string | reply_topic_name () const |
| Access the reply_topic_name configured in this instance of RequesterParams. | |
Used to pass configuration parameters when constructing a Requester.
RequesterParams is a valuetype that serves as a container of configuration parameters of a Requester. It is designed to mimic the named-parameters feature available in some programming languages, which improves readability.
| RequesterParams& DDS::rpc::RequesterParams::datareader_qos | ( | dds_entity_traits::DataReaderQos | qos | ) |
Assign the DataReaderQos to use.
This QoS will be used when the Requester creates a DataReader.
| RequesterParams& DDS::rpc::RequesterParams::datawriter_qos | ( | dds_entity_traits::DataWriterQos | qos | ) |
Assign the DataWriterQos to use.
This QoS will be used when the Requester creates a DataWriter.
| RequesterParams& DDS::rpc::RequesterParams::domain_participant | ( | dds_entity_traits::DomainParticipant | participant | ) |
Assign the DomainParticipant to use.
The requester will use this DomainParticipant to create any required Publisher, Subscriber, DataWriter and DataReader entities.
| RequesterParams& DDS::rpc::RequesterParams::publisher | ( | dds_entity_traits::Publisher | publisher | ) |
Assign the Publisher to use.
The Requester will use this publisher to create any required DataWriter entities. If not provided the Requester will create its own Publisher.
| RequesterParams& DDS::rpc::RequesterParams::reply_topic_name | ( | const std::string & | name | ) |
Assign the 'reply_topic_name'.
This overrides the default topic name generation.
| RequesterParams& DDS::rpc::RequesterParams::request_topic_name | ( | const std::string & | name | ) |
Assign the 'request_topic_name' to use as the Request topic name.
This overrides the default topic name generation.
| RequesterParams& DDS::rpc::RequesterParams::requester_listener | ( | RequesterListener< TReq, TRep > * | listener | ) |
Assign the 'requester' listener that will be installed in the Requester.
Only one listener may be installed, either the SimpleListener or RequesterListener.
| RequesterParams& DDS::rpc::RequesterParams::service_name | ( | const std::string & | name | ) |
Assign the service_name to use when creating the Request and Reply topic names.
The service_name is used when constructing the topic name used for the Request and Reply topics. If not explicitly defined by the request_topic_name() configuration item, the request topic is composed of <service_name>_Request. Similarly, if not overridden by reply_topic_name(), the reply topic name is composed of <service_name>_Reply. If the service_name() item is left unspecified, then the string "Service" is used.
| RequesterParams& DDS::rpc::RequesterParams::simple_requester_listener | ( | SimpleRequesterListener< TRep > * | listener | ) |
Assign the 'simple' listener that will be installed in the Requester.
Only one listener may be installed, either the SimpleListener or RequesterListener.
| RequesterParams& DDS::rpc::RequesterParams::subscriber | ( | dds_entity_traits::Subscriber | subscriber | ) |
Assign the Subscriber to use.
The Requester will use this subscriber to create any requried DataReader entities. If not provided, the Requester will create its own Subscriber.
