RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep > Class Template Reference

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

Inherits RTI.Connext.Queuing.Infrastructure.QueueRequestReplyEntityParams.

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

Detailed Description

Contains the parameters for creating a RTI::Connext::Queuing::QueueRequester<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

QueueRequesterParams()

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

inline

Creates a QueueRequesterParams with the parameters a QueueRequester always needs.

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

• request queue topic name (SetRequestQueueTopicName),
• shared subscriber name (SetSharedSubscriberName) for the reply queue

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

Parameters

participant	The DDS::DomainParticipant a QueueRequester uses to join a domain.
requestQueueTypeSupport	The type support for type TReq
replyQueueTypeSupport	The type support for type TRep

Member Function Documentation

SetRequestQueueTopicName()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< 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 for which the QueueRequester produces request samples.

See also

RTI::Connext::Queuing::QueueProducerParams<T>::SetQueueTopicName

SetReplyQueueTopicName()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< 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 from which the QueueRequester will consumes reply samples.

The reply topic name must match the topic name of the reply SharedReaderQueue in 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::QueueConsumerParams<T>::SetQueueTopicName

SetSharedSubscriberName()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetSharedSubscriberName ( String  sharedSubscriberName )

inline

Sets the SharedSubscriber name associated with the reply SharedReaderQueue.

See also

RTI::Connext::Queuing::QueueConsumerParams<T>::SetSharedSubscriberName

SetQosProfile()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetQosProfile ( String  qosLibraryName, String  qosProfileName  )

inline

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

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

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

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

Parameters

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

SetDataWriterQos()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetDataWriterQos ( DDS.DataWriterQos  dataWriterQos )

inline

Sets the quality of service of the request DataWriter.

See also

SetQosProfile

SetDataReaderQos()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetDataReaderQos ( DDS.DataReaderQos  dataReaderQos )

inline

Sets the quality of service of the reply DataReader.

See also

SetQosProfile

SetPublisher()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetPublisher ( DDS.Publisher  publisher )

inline

Sets a specific Publisher.

See also

RTI::Connext::Queuing::QueueProducerParams<T>::SetPublisher

SetSubscriber()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetSubscriber ( DDS.Subscriber  subscriber )

inline

Sets a specific Subscriber.

See also

RTI::Connext::Queuing::QueueConsumerParams<T>::SetSubscriber

SetEntityName()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetEntityName ( String  entityName )

inline

Sets the name of the QueueRequester.

The name of the QueueRequester is used along with the RTI::Connext::Queuing::QueueRequesterParams<TReq,TRep>::SetRequestQueueTopicName to generate the QueueRequester's GUID. By default, entity name is null, which results in the QueueRequester's GUID being set to the underlying request DataWriter's virtual GUID.

See also

RTI::Connext::Queuing::QueueRequester<TReq,TRep>::Guid

SetEnableAvailability()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetEnableAvailability ( Boolean  enableAvailability )

inline

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

See also

RTI::Connext::Queuing::QueueConsumerParams<T>::SetEnableAvailability.

SetListener()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetListener ( QueueRequesterListener< TReq, TRep >  listener )

inline

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

See also

RTI::Connext::Queuing::QueueRequesterListener<TReq,TRep>

SetEnableSampleReplication()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetEnableSampleReplication ( Boolean  enableSampleReplication )

inline

Causes the QueueRequester to write all the requests with the DDS::SampleInfo::flag including the bit DDS::SampleFlagBits::REPLICATE_SAMPLE.

See also

RTI::Connext::Queuing::QueueProducerParams<T>::SetEnableSampleReplication

SetEnableWaitForAck()

QueueRequesterParams<TReq, TRep> RTI.Connext.Queuing.QueueRequesterParams< TReq, TRep >.SetEnableWaitForAck ( Boolean  enableWaitForAck )

inline

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

See also

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