RTI.Connext.Queuing.QueueConsumerParams< T > Class Template Reference

Contains the parameters for creating a RTI::Connext::Queuing::QueueConsumer<T> More...

Inherits RTI.Connext.Queuing.Infrastructure.QueueEntityParams.

Public Member Functions
QueueConsumerParams< T >	SetQueueTopicName (String queueTopicName)
	Sets a specific queue topic name.
QueueConsumerParams< T >	SetSharedSubscriberName (String sharedSubscriberName)
	Sets the SharedSubscriber name associated with the SharedReaderQueue from which the QueueConsumer will receive samples.
QueueConsumerParams< T >	SetQosProfile (String qosLibraryName, String qosProfileName)
	Sets a QoS profile for the DDS entities created by a QueueConsumer.
QueueConsumerParams< T >	SetDataReaderQos (DDS.DataReaderQos dataReaderQos)
	Sets the quality of service of the QueueConsumer's DataReader.
QueueConsumerParams< T >	SetSubscriber (DDS.Subscriber subscriber)
	Sets a specific Subscriber.
QueueConsumerParams< T >	SetEntityName (String entityName)
	Sets the name of the QueueConsumer.
QueueConsumerParams< T >	SetEnableAvailability (Boolean enableAvailability)
	Indicates whether the availability channel is enabled for a QueueConsumer.
QueueConsumerParams< T >	SetListener (QueueConsumerListener< T > listener)
	Sets a listener that is called when different events affecting the QueueConsumer occur.
Public Member Functions inherited from RTI.Connext.Queuing.Infrastructure.QueueEntityParams
virtual void	Validate ()

Additional Inherited Members
Properties inherited from RTI.Connext.Queuing.Infrastructure.QueueEntityParams
DDS.DomainParticipant	Participant [get, set]
String	QueueTopicName [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::QueueConsumer<T>

Type Constraints

T	:	class
T	:	global
T	:	DDS.ICopyable<T>
T	:	new()

Member Function Documentation

QueueConsumerParams<T> RTI.Connext.Queuing.QueueConsumerParams< T >.SetQueueTopicName ( String  queueTopicName )

inline

Sets a specific queue topic name.

The queue topic name allows you to specify with which SharedReaderQueue the QueueConsumer communicates. It is a required parameter and must match the value of the topic name within the <shared_reader_queue> tag in the Queuing Service configuration. Note that for a QueueConsumer, the queue topic name is different than the DDS topic name of the underlying QueueConsumer's DataReader.

See Also

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

QueueConsumerParams<T> RTI.Connext.Queuing.QueueConsumerParams< T >.SetSharedSubscriberName ( String  sharedSubscriberName )

inline

Sets the SharedSubscriber name associated with the SharedReaderQueue from which the QueueConsumer will receive samples.

The SharedSubscriber name is a required parameter. It must match the name of the SharedSubscriber that contains the SharedReaderQueue from which the QueueConsumer's DataReader will receive samples.

QueueConsumerParams<T> RTI.Connext.Queuing.QueueConsumerParams< T >.SetQosProfile ( String  qosLibraryName, String  qosProfileName  )

inline

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

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

This includes the DataReader used to receive samples from the SharedReaderQueue and the DataWriter used to report availability to the SharedReaderQueue.

Alternatively, and only for the DataReader used to receive samples, you can set the QoS using SetDataReaderQos.

Parameters

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

QueueConsumerParams<T> RTI.Connext.Queuing.QueueConsumerParams< T >.SetDataReaderQos ( DDS.DataReaderQos  dataReaderQos )

inline

Sets the quality of service of the QueueConsumer's DataReader.

See Also

SetQosProfile

QueueConsumerParams<T> RTI.Connext.Queuing.QueueConsumerParams< T >.SetSubscriber ( DDS.Subscriber  subscriber )

inline

Sets a specific Subscriber.

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

QueueConsumerParams<T> RTI.Connext.Queuing.QueueConsumerParams< T >.SetEntityName ( String  entityName )

inline

Sets the name of the QueueConsumer.

The name of the QueueConsumer is used along with the SetQueueTopicName to generate the QueueConsumer's GUID. By default, entity name is null, which results in the QueueConsumer's GUID being set to the underlying DataReader's virtual GUID.

See Also

RTI::Connext::Queuing::QueueConsumer<T>::Guid

QueueConsumerParams<T> RTI.Connext.Queuing.QueueConsumerParams< T >.SetEnableAvailability ( Boolean  enableAvailability )

inline

Indicates whether the availability channel is enabled for a QueueConsumer.

When this parameter is set to true, the QueueConsumer creates a DataWriter to report its availability to the SharedReaderQueue from which the QueueConsumer receives samples.

The QueueConsumer can send availability samples to the SharedReaderQueue using the method RTI::Connext::Queuing::QueueConsumer<T>::SendAvailability(ConsumerAvailabilityParams_t)

See Also

RTI::Connext::Queuing::QueueConsumer<T>::SendAvailability(ConsumerAvailabilityParams_t)

QueueConsumerParams<T> RTI.Connext.Queuing.QueueConsumerParams< T >.SetListener ( QueueConsumerListener< T >  listener )

inline

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

See Also

RTI::Connext::Queuing::QueueConsumerListener<T>