com.toc.coredx.DDS.rpc.RequesterParams Class Reference

Public Member Functions
	RequesterParams ()
	RequesterParams (RequesterParams other)
RequesterParams	simple_requester_listener (SimpleRequesterListener<? extends ReplyType > listener)
RequesterParams	requester_listener (RequesterListener<? extends RequestType, ? extends ReplyType > 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() [1/2]

com.toc.coredx.DDS.rpc.RequesterParams.RequesterParams

(

)

Default constructor

RequesterParams() [2/2]

com.toc.coredx.DDS.rpc.RequesterParams.RequesterParams

(

RequesterParams

other

)

Copy constructor

Member Function Documentation

datareader_qos() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.datareader_qos

(

DataReaderQos

qos

)

Assign the DataReaderQos to use.

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

datareader_qos() [2/2]

DataReaderQos com.toc.coredx.DDS.rpc.RequesterParams.datareader_qos

(

)

Access the DataReaderQos configured in this instance of RequesterParams.

datawriter_qos() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.datawriter_qos

(

DataWriterQos

qos

)

Assign the DataWriterQos to use.

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

datawriter_qos() [2/2]

DataWriterQos com.toc.coredx.DDS.rpc.RequesterParams.datawriter_qos

(

)

Access the DataWriterQos configured in this instance of RequesterParams.

domain_participant() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.domain_participant

(

DomainParticipant

participant

)

Assign the DomainParticipant to use.

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

domain_participant() [2/2]

DomainParticipant com.toc.coredx.DDS.rpc.RequesterParams.domain_participant

(

)

Access the DomainParticipant configured in this instance of RequesterParams.

publisher() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.publisher

(

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.

publisher() [2/2]

Publisher com.toc.coredx.DDS.rpc.RequesterParams.publisher

(

)

Access the Publisher configured in this instance of RequesterParams.

reply_topic_name() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.reply_topic_name

(

String

name

)

Assign the 'reply_topic_name'.

This overrides the default topic name generation.

reply_topic_name() [2/2]

String com.toc.coredx.DDS.rpc.RequesterParams.reply_topic_name

(

)

Access the reply_topic_name configured in this instance of RequesterParams.

request_topic_name() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.request_topic_name

(

String

name

)

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

This overrides the default topic name generation.

request_topic_name() [2/2]

String com.toc.coredx.DDS.rpc.RequesterParams.request_topic_name

(

)

Access the request_topic_name configured in this instance of RequesterParams.

requester_listener() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.requester_listener

(

RequesterListener<? extends RequestType, ? extends ReplyType >

listener

)

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

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

requester_listener() [2/2]

ListenerBase com.toc.coredx.DDS.rpc.RequesterParams.requester_listener

(

)

Access the RequesterListener configured in this instance of RequesterParams.

service_name() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.service_name

(

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.

service_name() [2/2]

String com.toc.coredx.DDS.rpc.RequesterParams.service_name

(

)

Access the service_name configured in this instance of RequesterParams.

simple_requester_listener() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.simple_requester_listener

(

SimpleRequesterListener<? extends ReplyType >

listener

)

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

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

simple_requester_listener() [2/2]

ListenerBase com.toc.coredx.DDS.rpc.RequesterParams.simple_requester_listener

(

)

Access the SimpleRequesterListener configured in this instance of RequesterParams.

subscriber() [1/2]

RequesterParams com.toc.coredx.DDS.rpc.RequesterParams.subscriber

(

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.

subscriber() [2/2]

Subscriber com.toc.coredx.DDS.rpc.RequesterParams.subscriber

(

)

Access the Subscriber configured in this instance of RequesterParams.