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

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

Inherits RTI.Connext.Queuing.Infrastructure.QueueEntityParams.

Public Member Functions
	QueueProducerParams (DDS.DomainParticipant participant, DDS.TypeSupport queueTypeSupport)
	Creates a QueueProducerParams object with the parameters a QueueProducer always needs.
QueueProducerParams< T >	SetQueueTopicName (String queueTopicName)
	Sets a specific queue topic name.
QueueProducerParams< T >	SetQosProfile (String qosLibraryName, String qosProfileName)
	Sets a QoS profile for the DDS entities created by a QueueProducer.
QueueProducerParams< T >	SetDataWriterQos (DDS.DataWriterQos dataWriterQos)
	Sets the quality of service for the QueueProducer's DataWriter.
QueueProducerParams< T >	SetPublisher (DDS.Publisher publisher)
	Sets a specific Publisher.
QueueProducerParams< T >	SetEntityName (String entityName)
	Sets the name of the QueueProducer.
QueueProducerParams< T >	SetListener (QueueProducerListener< T > listener)
	Sets a listener that is called when different events affecting the QueueProducer occur.
QueueProducerParams< T >	SetEnableSampleReplication (Boolean enableSampleReplication)
	Causes the QueueProducer to write all the samples with the DDS::SampleInfo::flag including the bit ::DDS::SampleFlagBits::REPLICATE_SAMPLE.
QueueProducerParams< T >	SetEnableWaitForAck (Boolean enableWaitForAck)
	Enables the Queuing Service's 'Acknowledgment Management' feature for the QueueProducer.
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::QueueProducer<T>

Type Constraints

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

Constructor & Destructor Documentation

RTI.Connext.Queuing.QueueProducerParams< T >.QueueProducerParams ( DDS.DomainParticipant  participant, DDS.TypeSupport  queueTypeSupport  )

inline

Creates a QueueProducerParams object with the parameters a QueueProducer always needs.

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

• Queue topic name (SetQueueTopicName)

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

Parameters

participant	The DDS::DomainParticipant a QueueProducer uses to join a domain.
queueTypeSupport	The type support for type T

Member Function Documentation

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

inline

Sets a specific queue topic name.

The queue topic name allows you to specify with which SharedReaderQueue the QueueProducer communicates. This 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 QueueProducer, the queue topic name also matches the DDS topic name of the underlying QueueProducer's DataWriter.

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

inline

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

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

This includes the DataWriter used to send samples to a SharedReaderQueue.

Alternatively, you can set the DataWriter QoS using SetDataWriterQos.

Parameters

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

QueueProducerParams<T> RTI.Connext.Queuing.QueueProducerParams< T >.SetDataWriterQos ( DDS.DataWriterQos  dataWriterQos )

inline

Sets the quality of service for the QueueProducer's DataWriter.

See Also

SetQosProfile

QueueProducerParams<T> RTI.Connext.Queuing.QueueProducerParams< T >.SetPublisher ( DDS.Publisher  publisher )

inline

Sets a specific Publisher.

By default, a QueueProducer uses the DomainParticipant's implicit Publisher. Sometimes a different Publisher may be needed, for example, to use non-default PublisherQos.

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

inline

Sets the name of the QueueProducer.

The name of the QueueProducer is used along with the RTI::Connext::Queuing::QueueProducerParams<T>::SetQueueTopicName to generate the QueueProducer's GUID. By default, entity_name is null, which results in the QueueProducer's source GUID being set to the underlying DataWriter's virtual GUID.

See Also

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

QueueProducerParams<T> RTI.Connext.Queuing.QueueProducerParams< T >.SetListener ( QueueProducerListener< T >  listener )

inline

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

See Also

RTI::Connext::Queuing::QueueProducerListener<T>

QueueProducerParams<T> RTI.Connext.Queuing.QueueProducerParams< T >.SetEnableSampleReplication ( Boolean  enableSampleReplication )

inline

Causes the QueueProducer to write all the samples with the DDS::SampleInfo::flag including the bit ::DDS::SampleFlagBits::REPLICATE_SAMPLE.

When this value is set to true, all the samples are written with the associated metadata containing the bit ::DDS::SampleFlagBits::REPLICATE_SAMPLE. This behavior cannot be changed once this option is enabled (no matter which operation is used to send samples).

QueueProducerParams<T> RTI.Connext.Queuing.QueueProducerParams< T >.SetEnableWaitForAck ( Boolean  enableWaitForAck )

inline

Enables the Queuing Service's 'Acknowledgment Management' feature for the QueueProducer.

When this value is set to true, you can call the APIs RTI::Connext::Queuing::QueueProducer<T>::WaitForAcknowledgements(Duration_t) and RTI::Connext::Queuing::QueueProducer<T>::WaitForAcknowledgements(SampleIdentity_t,Duration_t) to wait for acknowledgments from Queuing Service. These acknowledgments indicate whether or not samples have been successfully enqueued.

Notice that if you enable this feature, at some point you must call RTI::Connext::Queuing::QueueProducer<T>::WaitForAcknowledgements(Duration_t) or RTI::Connext::Queuing::QueueProducer<T>::WaitForAcknowledgements(SampleIdentity_t,Duration_t). Otherwise, the QueueProducer's memory will grow unbounded, since it will keep some state per sample.

You must also set the XML tag <app_ack_sample_to_producer> under <queue_qos>/<reliability> to true.

[default] true