RTI.Connext.RequestReply.RequesterParams Class Reference

Contains the parameters for creating a RTI::Connext::RequestReply::Requester<TReq,TRep> More...

Inherits RTI.Connext.RequestReply.Infrastructure.EntityParams.

Public Member Functions
	RequesterParams (DDS.DomainParticipant participant, DDS.TypeSupport requestTypeSupport, DDS.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 (DDS.DataWriterQos dataWriterQos)
	Sets the quality of service of the request DataWriter.
RequesterParams	SetDataReaderQos (DDS.DataReaderQos dataReaderQos)
	Sets the quality of service of the request DataReader.
RequesterParams	SetPublisher (DDS.Publisher publisher)
	Sets a specific Publisher.
RequesterParams	SetSubscriber (DDS.Subscriber subscriber)
	Sets a specific Subscriber.
Public Member Functions inherited from RTI.Connext.RequestReply.Infrastructure.EntityParams
virtual void	Validate ()

Additional Inherited Members
Properties inherited from RTI.Connext.RequestReply.Infrastructure.EntityParams
DDS.DomainParticipant	Participant [get, set]
String	ServiceName [get, set]
String	RequestTopicName [get, set]
String	ReplyTopicName [get, set]
DDS.DataWriterQos	DataWriterQos [get, set]
DDS.DataReaderQos	DataReaderQos [get, set]
String	QosLibraryName [get, set]
String	QosProfileName [get, set]
DDS.Publisher	Publisher [get, set]
DDS.Subscriber	Subscriber [get, set]

Detailed Description

Contains the parameters for creating a RTI::Connext::RequestReply::Requester<TReq,TRep>

See Also

Creating a Requester with optional parameters

Constructor & Destructor Documentation

RTI.Connext.RequestReply.RequesterParams.RequesterParams ( DDS.DomainParticipant  participant, DDS.TypeSupport  requestTypeSupport, DDS.TypeSupport  replyTypeSupport  )

inline

Creates a RequesterParams with the parameters a Requester always needs.

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

• A service name (SetServiceName),
• Or custom topic names (SetRequestTopicName and SetReplyTopicName)

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

Parameters

participant	The DDS::DomainParticipant this requester uses to join a domain.
requestTypeSupport	The type support for type TReq
replyTypeSupport	The type support for type TReq

See Also

Creating a Requester with optional parameters

Member Function Documentation

RequesterParams RTI.Connext.RequestReply.RequesterParams.SetServiceName ( String  serviceName )

inline

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 and SetReplyTopicName.

RequesterParams RTI.Connext.RequestReply.RequesterParams.SetRequestTopicName ( String  requestTopicName )

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 SetServiceName.

RequesterParams RTI.Connext.RequestReply.RequesterParams.SetReplyTopicName ( String  replyTopicName )

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 the SetServiceName.

RequesterParams RTI.Connext.RequestReply.RequesterParams.SetQosProfile ( String  qosLibraryName, String  qosProfileName  )

inline

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 (RTI::Connext::RequestReply::RequesterParams::SetDataWriterQos, RTI::Connext::RequestReply::RequesterParams::SetDataReaderQos).

Parameters

qosLibraryName	The name of the QoS library
qosProfileName	The name of the QoS profile inside the QoS library

See Also

Configuring Request-Reply QoS profiles

Configuring QoS Profiles with XML

RequesterParams RTI.Connext.RequestReply.RequesterParams.SetDataWriterQos ( DDS.DataWriterQos  dataWriterQos )

inline

Sets the quality of service of the request DataWriter.

See Also

SetQosProfile

RequesterParams RTI.Connext.RequestReply.RequesterParams.SetDataReaderQos ( DDS.DataReaderQos  dataReaderQos )

inline

Sets the quality of service of the request DataReader.

See Also

SetQosProfile

RequesterParams RTI.Connext.RequestReply.RequesterParams.SetPublisher ( DDS.Publisher  publisher )

inline

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 RTI.Connext.RequestReply.RequesterParams.SetSubscriber ( DDS.Subscriber  subscriber )

inline

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.