RTI Connext Java API  Version 5.2.0
 All Classes Namespaces Functions Variables Groups Pages
RequesterParams Class Reference

Contains the parameters for creating a com.rti.connext.requestreply.Requester<TReq,TRep> More...

Inherits EntityParams.

Public Member Functions

 RequesterParams (DomainParticipant participant, TypeSupport requestTypeSupport, TypeSupport replyTypeSupport)
 Creates a RequesterParams with the parameters a Requester always needs.
 
RequesterParams setServiceName (String serviceName)
 The service name that Repliers and Requester use to match and communicate.
 
RequesterParams setRequestTopicName (String requestTopicName)
 Sets a specific request topic name.
 
RequesterParams setReplyTopicName (String replyTopicName)
 Sets a specific reply topic name.
 
RequesterParams setQosProfile (String qosLibraryName, String qosProfileName)
 Sets a QoS profile for the entities in this requester.
 
RequesterParams setDataWriterQos (DataWriterQos dataWriterQos)
 Sets the quality of service of the request DataWriter.
 
RequesterParams setDataReaderQos (DataReaderQos dataReaderQos)
 Sets the quality of service of the request DataReader.
 
RequesterParams setPublisher (Publisher publisher)
 Sets a specific Publisher.
 
RequesterParams setSubscriber (Subscriber subscriber)
 Sets a specific Subscriber.
 
- Public Member Functions inherited from EntityParams
DomainParticipant getParticipant ()
 
String getServiceName ()
 
String getRequestTopicName ()
 
String getReplyTopicName ()
 
DataWriterQos getDataWriterQos ()
 
DataReaderQos getDataReaderQos ()
 
String getQosLibraryName ()
 
String getQosProfileName ()
 
Publisher getPublisher ()
 
Subscriber getSubscriber ()
 
void validate ()
 

Detailed Description

Constructor & Destructor Documentation

RequesterParams ( DomainParticipant  participant,
TypeSupport  requestTypeSupport,
TypeSupport  replyTypeSupport 
)

Creates a RequesterParams with the parameters a Requester always needs.

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

The rest of the parameters that can be set in a RequesterParams object are optional.

Parameters
participantThe com.rti.dds.domain.DomainParticipant this requester uses to join a domain.
requestTypeSupportThe type support for type TReq
replyTypeSupportThe type support for type TReq
See Also
Creating a Requester with optional parameters

Member Function Documentation

RequesterParams setServiceName ( String  serviceName)

The service name that Repliers and Requester use to match and communicate.

A Requester and a Replier need to be configured with the same topic names in order to match.

The service name is used to generate a request topic and a reply topic that the Requester and Replier will use to communicate. For example, the service name "MyService" will be used to create topics named "MyServiceRequest" and "MyServiceReply".

In some cases, the name of these topics is known beforehand or needs to be customized for another reason. The service name can be overridden by setting specific request and reply topic names using setRequestTopicName(String) and setReplyTopicName(String).

RequesterParams setRequestTopicName ( String  requestTopicName)

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 setServiceName(String).

RequesterParams setReplyTopicName ( String  replyTopicName)

Sets a specific reply topic name.

The specified topic name will be used, instead of allowing a topic name to be generated based on the setServiceName(String).

RequesterParams setQosProfile ( String  qosLibraryName,
String  qosProfileName 
)

Sets a QoS profile for the entities in this requester.

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

Within that profile, the DataWriter QoS in <datawriter_qos> will be used to configure the request DataWriter and the DataReader.

Alternatively, you can set the QoS using the DataWriterQos and DataReaderQos objects (com.rti.connext.requestreply.RequesterParams.setDataWriterQos(DataWriterQos), com.rti.connext.requestreply.RequesterParams.setDataReaderQos(DataReaderQos)).

Parameters
qosLibraryNameThe name of the QoS library
qosProfileNameThe name of the QoS profile inside the QoS library
See Also
Configuring Request-Reply QoS profiles
Configuring QoS Profiles with XML
RequesterParams setDataWriterQos ( DataWriterQos  dataWriterQos)

Sets the quality of service of the request DataWriter.

See Also
setQosProfile(String,String)
RequesterParams setDataReaderQos ( DataReaderQos  dataReaderQos)

Sets the quality of service of the request DataReader.

See Also
setQosProfile(String,String)
RequesterParams setPublisher ( Publisher  publisher)

Sets a specific Publisher.

By default, a Requester uses the DomainParticipant's implicit Publisher. Sometimes a different Publisher may be needed, for example, to use non-default PublisherQos.

RequesterParams setSubscriber ( Subscriber  subscriber)

Sets a specific Subscriber.

By default, a Requester uses the DomainParticipant's implicit Subscriber. Sometimes a different Subscriber may be needed, for example, to use non-default SubscriberQos.


RTI Connext Java API Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc