RTI Connext .Net APIs  Version 5.2.0
 All Classes Namespaces Functions Variables Enumerations Properties Groups Pages
RTI.Connext.Queuing.QueueReplierParams< TReq, TRep > Class Template Reference

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

Inherits RTI.Connext.Queuing.Infrastructure.QueueRequestReplyEntityParams.

Public Member Functions

 QueueReplierParams (DDS.DomainParticipant participant, DDS.TypeSupport requestQueueTypeSupport, DDS.TypeSupport replyQueueTypeSupport)
 Creates a QueueReplierParams with the parameters a QueueReplier always needs.
 
QueueReplierParams< TReq, TRep > SetRequestQueueTopicName (String requestQueueTopicName)
 Sets a specific request queue topic name.
 
QueueReplierParams< TReq, TRep > SetReplyQueueTopicName (String replyQueueTopicName)
 Sets a specific reply queue topic name.
 
QueueReplierParams< TReq, TRep > SetSharedSubscriberName (String sharedSubscriberName)
 Sets the SharedSubscriber name associated with the request SharedReaderQueue.
 
QueueReplierParams< TReq, TRep > SetQosProfile (String qosLibraryName, String qosProfileName)
 Sets a QoS profile for the DDS entities created by a QueueReplier.
 
QueueReplierParams< TReq, TRep > SetDataWriterQos (DDS.DataWriterQos dataWriterQos)
 Sets the quality of service of the reply DataWriter.
 
QueueReplierParams< TReq, TRep > SetDataReaderQos (DDS.DataReaderQos dataReaderQos)
 Sets the quality of service of the reply DataReader.
 
QueueReplierParams< TReq, TRep > SetPublisher (DDS.Publisher publisher)
 Sets a specific Publisher.
 
QueueReplierParams< TReq, TRep > SetSubscriber (DDS.Subscriber subscriber)
 Sets a specific Subscriber.
 
QueueReplierParams< TReq, TRep > SetEnableAvailability (Boolean enableAvailability)
 Indicates whether the availability channel is enabled with the request SharedReaderQueue.
 
QueueReplierParams< TReq, TRep > SetEntityName (String entityName)
 Sets the name of the QueueReplier.
 
QueueReplierParams< TReq, TRep > SetListener (QueueReplierListener< TReq, TRep > listener)
 Sets a listener that is called when different events affecting the QueueReplier occur.
 
QueueReplierParams< TReq, TRep > SetEnableSampleReplication (Boolean enableSampleReplication)
 Causes the QueueReplier to write all the replies with the DDS::SampleInfo::flag including the bit ::DDS::SampleFlagBits::REPLICATE_SAMPLE.
 
QueueReplierParams< TReq, TRep > SetEnableWaitForAck (Boolean enableWaitForAck)
 Enables Queuing Service's 'Acknowledgment Management' feature for replies.
 
- Public Member Functions inherited from RTI.Connext.Queuing.Infrastructure.QueueRequestReplyEntityParams
virtual void Validate ()
 

Additional Inherited Members

- Properties inherited from RTI.Connext.Queuing.Infrastructure.QueueRequestReplyEntityParams
DDS.DomainParticipant Participant [get, set]
 
String RequestQueueTopicName [get, set]
 
String ReplyQueueTopicName [get, set]
 
String SharedSubscriberName [get, set]
 
DDS.DataWriterQos DataWriterQos [get, set]
 
DDS.DataReaderQos DataReaderQos [get, set]
 
DDS.Publisher Publisher [get, set]
 
DDS.Subscriber Subscriber [get, set]
 
String QosLibraryName [get, set]
 
String QosProfileName [get, set]
 
String EntityName [get, set]
 

Detailed Description

Contains the parameters for creating a RTI::Connext::Queuing::QueueReplier<TReq,TRep>.

Type Constraints
TReq :class 
TReq :global 
TReq :DDS.ICopyable<TReq> 
TReq :new() 
TRep :class 
TRep :global 
TRep :DDS.ICopyable<TRep> 
TRep :new() 

Constructor & Destructor Documentation

RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.QueueReplierParams ( DDS.DomainParticipant  participant,
DDS.TypeSupport  requestQueueTypeSupport,
DDS.TypeSupport  replyQueueTypeSupport 
)
inline

Creates a QueueReplierParams with the parameters a QueueReplier always needs.

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

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

Parameters
participantThe DDS::DomainParticipant a QueueReplier uses to join a domain.
requestQueueTypeSupportThe type support for type TReq
replyQueueTypeSupportThe type support for type TRep

Member Function Documentation

QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetRequestQueueTopicName ( String  requestQueueTopicName)
inline

Sets a specific request queue topic name.

The request queue topic name allows you to specify the request SharedReaderQueue from which the QueueReplier receives request samples.

See Also
RTI::Connext::Queuing::QueueConsumerParams<T>::SetQueueTopicName
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetReplyQueueTopicName ( String  replyQueueTopicName)
inline

Sets a specific reply queue topic name.

The reply queue topic name allows you to specify the reply SharedReaderQueue for which the QueueReplier produces replies.

The reply topic name must match the topic name of the reply queue that is set in the <shared_reader_queue> tag of the Queuing Service configuration.

This parameter can be null. In this case, the default reply queue topic name will be used. The default name is based on the request queue topic name.

See Also
RTI::Connext::Queuing::QueueProducerParams<T>::SetQueueTopicName
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetSharedSubscriberName ( String  sharedSubscriberName)
inline

Sets the SharedSubscriber name associated with the request SharedReaderQueue.

See Also
RTI::Connext::Queuing::QueueConsumerParams<T>::SetSharedSubscriberName
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetQosProfile ( String  qosLibraryName,
String  qosProfileName 
)
inline

Sets a QoS profile for the DDS entities created by a QueueReplier.

Specifies an XML QoS profile that will be used to configure the quality of service of the DDS entities created by a QueueReplier.

This includes the DataReader used to receive requests, the DataWriter used to send replies, and the DataWriter used to report availability to the request SharedReaderQueue.

Alternatively, you can set the QoS for the request DataReader using SetDataReaderQos and the QoS for the reply DataWriter using SetDataWriterQos.

Parameters
qosLibraryNameThe name of the QoS library
qosProfileNameThe name of the QoS profile inside the QoS library
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetDataWriterQos ( DDS.DataWriterQos  dataWriterQos)
inline

Sets the quality of service of the reply DataWriter.

See Also
SetQosProfile
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetDataReaderQos ( DDS.DataReaderQos  dataReaderQos)
inline

Sets the quality of service of the reply DataReader.

See Also
SetQosProfile
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetPublisher ( DDS.Publisher  publisher)
inline
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetSubscriber ( DDS.Subscriber  subscriber)
inline
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetEnableAvailability ( Boolean  enableAvailability)
inline

Indicates whether the availability channel is enabled with the request SharedReaderQueue.

See Also
RTI::Connext::Queuing::QueueConsumerParams<T>::SetEnableAvailability.
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetEntityName ( String  entityName)
inline

Sets the name of the QueueReplier.

The name of the QueueReplier is used along with the RTI::Connext::Queuing::QueueReplierParams<TReq,TRep>::SetRequestQueueTopicName to generate the QueueReplier's GUID. By default, entity_name is null, which results in the QueueReplier's GUID being set to the underlying reply DataReader's virtual GUID.

See Also
RTI::Connext::Queuing::QueueReplier<TReq,TRep>::Guid
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetListener ( QueueReplierListener< TReq, TRep >  listener)
inline

Sets a listener that is called when different events affecting the QueueReplier occur.

See Also
RTI::Connext::Queuing::QueueReplierListener<TReq,TRep>
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetEnableSampleReplication ( Boolean  enableSampleReplication)
inline

Causes the QueueReplier to write all the replies with the DDS::SampleInfo::flag including the bit ::DDS::SampleFlagBits::REPLICATE_SAMPLE.

See Also
RTI::Connext::Queuing::QueueProducerParams<T>::SetEnableSampleReplication
QueueReplierParams<TReq, TRep> RTI.Connext.Queuing.QueueReplierParams< TReq, TRep >.SetEnableWaitForAck ( Boolean  enableWaitForAck)
inline

Enables Queuing Service's 'Acknowledgment Management' feature for replies.

See Also
RTI::Connext::Queuing::QueueProducerParams<T>::SetEnableWaitForAck

RTI Connext .Net APIs Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc