CoreDX DDS C# Reference Manual
Public Member Functions | List of all members
RequesterParams Class Reference

Public Member Functions

 RequesterParams ()
 
 RequesterParams (RequesterParams other)
 
RequesterParams simple_requester_listener< TRep > (SimpleRequesterListener< TRep > listener)
 
RequesterParams requester_listener< TReq, TRep > (RequesterListener< TReq, TRep > listener)
 
RequesterParams domain_participant (DomainParticipant participant)
 
RequesterParams publisher (Publisher publisher)
 
RequesterParams subscriber (Subscriber subscriber)
 
RequesterParams datawriter_qos (DataWriterQos qos)
 
RequesterParams datareader_qos (DataReaderQos qos)
 
RequesterParams service_name (String name)
 
RequesterParams request_topic_name (String name)
 
RequesterParams reply_topic_name (String name)
 
DomainParticipant domain_participant ()
 
Publisher publisher ()
 
Subscriber subscriber ()
 
DataWriterQos datawriter_qos ()
 
DataReaderQos datareader_qos ()
 
ListenerBase simple_requester_listener ()
 
ListenerBase requester_listener ()
 
String service_name ()
 
String request_topic_name ()
 
String reply_topic_name ()
 

Detailed Description

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.

Constructor & Destructor Documentation

RequesterParams ( )
inline

Default constructor

RequesterParams ( RequesterParams  other)
inline

Copy constructor

Member Function Documentation

RequesterParams datareader_qos ( DataReaderQos  qos)
inline

Assign the DataReaderQos to use.

This QoS will be used when the Requester creates a DataReader.

DataReaderQos datareader_qos ( )
inline

Access the DataReaderQos configured in this instance of RequesterParams.

RequesterParams datawriter_qos ( DataWriterQos  qos)
inline

Assign the DataWriterQos to use.

This QoS will be used when the Requester creates a DataWriter.

DataWriterQos datawriter_qos ( )
inline

Access the DataWriterQos configured in this instance of RequesterParams.

RequesterParams domain_participant ( DomainParticipant  participant)
inline

Assign the DomainParticipant to use.

The requester will use this DomainParticipant to create any required Publisher, Subscriber, DataWriter and DataReader entities.

DomainParticipant domain_participant ( )
inline

Access the DomainParticipant configured in this instance of RequesterParams.

RequesterParams publisher ( Publisher  publisher)
inline

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.

Publisher publisher ( )
inline

Access the Publisher configured in this instance of RequesterParams.

RequesterParams reply_topic_name ( String  name)
inline

Assign the 'reply_topic_name'.

This overrides the default topic name generation.

String reply_topic_name ( )
inline

Access the reply_topic_name configured in this instance of RequesterParams.

RequesterParams request_topic_name ( String  name)
inline

Assign the 'request_topic_name' to use as the Request topic name.

This overrides the default topic name generation.

String request_topic_name ( )
inline

Access the request_topic_name configured in this instance of RequesterParams.

ListenerBase requester_listener ( )
inline

Access the RequesterListener configured in this instance of RequesterParams.

RequesterParams requester_listener< TReq, TRep > ( RequesterListener< TReq, TRep >  listener)
inline

Assign the 'requester' listener that will be installed in the Requester.

Only one listener may be installed, either the SimpleListener or RequesterListener.

Type Constraints
TReq :RequestType 
TReq :new() 
TRep :ReplyType 
TRep :new() 
RequesterParams service_name ( String  name)
inline

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.

String service_name ( )
inline

Access the service_name configured in this instance of RequesterParams.

ListenerBase simple_requester_listener ( )
inline

Access the SimpleRequesterListener configured in this instance of RequesterParams.

Assign the 'simple' listener that will be installed in the Requester.

Only one listener may be installed, either the SimpleListener or RequesterListener.

Type Constraints
TRep :ReplyType 
TRep :new() 
RequesterParams subscriber ( Subscriber  subscriber)
inline

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.

Subscriber subscriber ( )
inline

Access the Subscriber configured in this instance of RequesterParams.


© 2009-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.