rti::queuing::ConsumerAvailabilityParams Class Reference

Definition of the availability feedback information that can be provided by consumers to Queuing Service. More...

#include <QueueSupport.hpp>

Public Attributes
bool	reception_enabled
	Flag that provides a way to indicate whether or not the QueueConsumer can receive samples from Queuing Service.
int	unacked_threshold
	Maximum number of samples pending acknowledgement that the QueueConsumer can have to maintain sample reception.

Detailed Description

Definition of the availability feedback information that can be provided by consumers to Queuing Service.

Member Data Documentation

bool rti::queuing::ConsumerAvailabilityParams::reception_enabled

Flag that provides a way to indicate whether or not the QueueConsumer can receive samples from Queuing Service.

This value acts as a switch that QueueConsumers can use to temporarily enable or disable the reception of samples from Queuing Service.

int rti::queuing::ConsumerAvailabilityParams::unacked_threshold

Maximum number of samples pending acknowledgement that the QueueConsumer can have to maintain sample reception.

Note: This value is only applied when ConsumerAvailabilityParams::reception_enabled is true.

Once this value is reached, the QueueConsumer will not receive more samples until it acknowledged enough samples so that it is one again under the unacked threshold.

This value has precedence over the unacked threshold settings defined in the Queuing Service configuration. This allows you to dynamically change the threshold on a per Consumer basis.