RTI Connext C# API Version 7.2.0
Rti.RequestReply.RequesterBuilder< TRequest, TReply > Class Template Reference

A builder that allows configuring and creating a new Requester. It can be retrieved via participant.BuildRequester<TRequest, TReply>() (an extension method defined in DomainParticipantRequestReplyExtensions). More...

Public Member Functions

RequesterBuilder< TRequest, TReply > WithTopicNames (string requestTopicName, string replyTopicName)
 Sets RequestTopicName and ReplyTopicName. More...
 
RequesterBuilder< TRequest, TReply > WithServiceName (string serviceName)
 Sets ServiceName. More...
 
RequesterBuilder< TRequest, TReply > WithPublisher (Publisher publisher)
 Sets Publisher. More...
 
RequesterBuilder< TRequest, TReply > WithSubscriber (Subscriber subscriber)
 Sets Subscriber. More...
 
RequesterBuilder< TRequest, TReply > WithDataWriterQos (DataWriterQos dataWriterQos)
 Sets DataWriterQos. More...
 
RequesterBuilder< TRequest, TReply > WithDataReaderQos (DataReaderQos dataReaderQos)
 Sets DataReaderQos. More...
 
RequesterBuilder< TRequest, TReply > WithRequestDynamicType (DynamicType requestDynamicType)
 Sets RequestDynamicType. More...
 
RequesterBuilder< TRequest, TReply > WithReplyDynamicType (DynamicType replyDynamicType)
 Sets ReplyDynamicType. More...
 
Requester< TRequest, TReply > Create ()
 Creates a new Requester object using the current properties of the RequesterBuilder<TRequest, TReply> instance. More...
 

Properties

DomainParticipant Participant [get]
 The DomainParticipant used by the Requester. More...
 
string RequestTopicName [get, set]
 The name of the request topic a Requester and a Replier use to match. More...
 
string ReplyTopicName [get, set]
 The name of the reply topic a Requester and a Replier use to match. More...
 
string ServiceName [get, set]
 The service name that a Requester and a Replier use to match. More...
 
Publisher Publisher [get, set]
 The publisher used by the Requester. More...
 
Subscriber Subscriber [get, set]
 The subscriber used by the Requester. More...
 
DataWriterQos DataWriterQos [get, set]
 The QoS used by the Requester's underlying DataWriter<TReply>. More...
 
DataReaderQos DataReaderQos [get, set]
 The QoS used by the Requester's underlying DataReader<TRequest>. More...
 
DynamicType RequestDynamicType [get, set]
 The request type, when Rti.Types.Dynamic.DynamicData is used. More...
 
DynamicType ReplyDynamicType [get, set]
 The reply type, when Rti.Types.Dynamic.DynamicData is used. More...
 

Detailed Description

A builder that allows configuring and creating a new Requester. It can be retrieved via participant.BuildRequester<TRequest, TReply>() (an extension method defined in DomainParticipantRequestReplyExtensions).

The builder's configuration will be used to create the resulting Requester. Either WithTopicNames or WithServiceName has to be used to set the corresponding properties for creation to be successful. The rest of properties will use the default configuration if not specified.

Member Function Documentation

◆ WithTopicNames()

RequesterBuilder< TRequest, TReply > Rti.RequestReply.RequesterBuilder< TRequest, TReply >.WithTopicNames ( string  requestTopicName,
string  replyTopicName 
)
inline

Sets RequestTopicName and ReplyTopicName.

Parameters
requestTopicNameThe new RequestTopicName to be set.
replyTopicNameThe new ReplyTopicName to be set.
Returns
The same builder.

Either the topic names or ServiceName have to be set in order to call Create().

◆ WithServiceName()

RequesterBuilder< TRequest, TReply > Rti.RequestReply.RequesterBuilder< TRequest, TReply >.WithServiceName ( string  serviceName)
inline

Sets ServiceName.

Parameters
serviceNameThe new ServiceName to be set.
Returns
The same builder.

Either the topic names or ServiceName have to be set in order to call Create().

◆ WithPublisher()

RequesterBuilder< TRequest, TReply > Rti.RequestReply.RequesterBuilder< TRequest, TReply >.WithPublisher ( Publisher  publisher)
inline

Sets Publisher.

Parameters
publisherThe new Publisher to be set.
Returns
The same builder.

◆ WithSubscriber()

RequesterBuilder< TRequest, TReply > Rti.RequestReply.RequesterBuilder< TRequest, TReply >.WithSubscriber ( Subscriber  subscriber)
inline

Sets Subscriber.

Parameters
subscriberThe new Subscriber to be set.
Returns
The same builder.

◆ WithDataWriterQos()

RequesterBuilder< TRequest, TReply > Rti.RequestReply.RequesterBuilder< TRequest, TReply >.WithDataWriterQos ( DataWriterQos  dataWriterQos)
inline

Sets DataWriterQos.

Parameters
dataWriterQosThe new DataWriterQos to be set.
Returns
The same builder.

◆ WithDataReaderQos()

RequesterBuilder< TRequest, TReply > Rti.RequestReply.RequesterBuilder< TRequest, TReply >.WithDataReaderQos ( DataReaderQos  dataReaderQos)
inline

Sets DataReaderQos.

Parameters
dataReaderQosThe new DataReaderQos to be set.
Returns
The same builder.

◆ WithRequestDynamicType()

RequesterBuilder< TRequest, TReply > Rti.RequestReply.RequesterBuilder< TRequest, TReply >.WithRequestDynamicType ( DynamicType  requestDynamicType)
inline

Sets RequestDynamicType.

Parameters
requestDynamicTypeThe new RequestDynamicType to be set.
Returns
The same builder.

◆ WithReplyDynamicType()

RequesterBuilder< TRequest, TReply > Rti.RequestReply.RequesterBuilder< TRequest, TReply >.WithReplyDynamicType ( DynamicType  replyDynamicType)
inline

Sets ReplyDynamicType.

Parameters
replyDynamicTypeThe new ReplyDynamicType to be set.
Returns
The same builder.

◆ Create()

Requester< TRequest, TReply > Rti.RequestReply.RequesterBuilder< TRequest, TReply >.Create ( )
inline

Creates a new Requester object using the current properties of the RequesterBuilder<TRequest, TReply> instance.

Returns
The new Requester object.

Property Documentation

◆ Participant

DomainParticipant Rti.RequestReply.RequesterBuilder< TRequest, TReply >.Participant
get

The DomainParticipant used by the Requester.

◆ RequestTopicName

string Rti.RequestReply.RequesterBuilder< TRequest, TReply >.RequestTopicName
getset

The name of the request topic a Requester and a Replier use to match.

Either both topic names or ServiceName have to be set.

◆ ReplyTopicName

string Rti.RequestReply.RequesterBuilder< TRequest, TReply >.ReplyTopicName
getset

The name of the reply topic a Requester and a Replier use to match.

Either both topic names or ServiceName have to be set.

◆ ServiceName

string Rti.RequestReply.RequesterBuilder< TRequest, TReply >.ServiceName
getset

The service name that a Requester and a Replier use to match.

Either both topic names or ServiceName have to be set.

◆ Publisher

The publisher used by the Requester.

◆ Subscriber

The subscriber used by the Requester.

◆ DataWriterQos

The QoS used by the Requester's underlying DataWriter<TReply>.

◆ DataReaderQos

The QoS used by the Requester's underlying DataReader<TRequest>.

◆ RequestDynamicType

DynamicType Rti.RequestReply.RequesterBuilder< TRequest, TReply >.RequestDynamicType
getset

The request type, when Rti.Types.Dynamic.DynamicData is used.

This is required when the Requester's TRequest is Rti.Types.Dynamic.DynamicData.

◆ ReplyDynamicType

DynamicType Rti.RequestReply.RequesterBuilder< TRequest, TReply >.ReplyDynamicType
getset

The reply type, when Rti.Types.Dynamic.DynamicData is used.

This is required when the Requester's TReply is Rti.Types.Dynamic.DynamicData.