RTI Connext C API  Version 6.1.0
DDS_DataWriterCacheStatus Struct Reference

<<extension>> The status of the DataWriter's cache. Provides information on cache related metrics such as the number of samples and instances in the DataWriter queue. More...

Data Fields

DDS_LongLong sample_count_peak
 The highest value of DDS_DataWriterCacheStatus::sample_count over the lifetime of the DataWriter. More...
 
DDS_LongLong sample_count
 The number of samples in the DataWriter's queue. This statistic includes meta-samples that represent the unregistration or disposal of an instance. More...
 
DDS_LongLong alive_instance_count
 The number of instances currently in the DataWriter's queue that have an instance_state equal to DDS_ALIVE_INSTANCE_STATE. More...
 
DDS_LongLong alive_instance_count_peak
 The highest value of DDS_DataWriterCacheStatus::alive_instance_count over the lifetime of the DataWriter. More...
 
DDS_LongLong disposed_instance_count
 The number of instances currently in the DataWriter's queue that have an instance_state equal to DDS_NOT_ALIVE_DISPOSED_INSTANCE_STATE (due to, for example, being disposed via the FooDataWriter_dispose operation). More...
 
DDS_LongLong disposed_instance_count_peak
 The highest value of DDS_DataWriterCacheStatus::disposed_instance_count over the lifetime of the DataWriter. More...
 
DDS_LongLong unregistered_instance_count
 The number of instances currently in the DataWriter's queue that the DataWriter has unregistered from via the FooDataWriter_unregister_instance operation. More...
 
DDS_LongLong unregistered_instance_count_peak
 The highest value of DDS_DataWriterCacheStatus::unregistered_instance_count over the lifetime of the DataWriter. More...
 

Detailed Description

<<extension>> The status of the DataWriter's cache. Provides information on cache related metrics such as the number of samples and instances in the DataWriter queue.

Entity:
DDS_DataWriter

Field Documentation

◆ sample_count_peak

DDS_LongLong DDS_DataWriterCacheStatus::sample_count_peak

The highest value of DDS_DataWriterCacheStatus::sample_count over the lifetime of the DataWriter.

◆ sample_count

DDS_LongLong DDS_DataWriterCacheStatus::sample_count

The number of samples in the DataWriter's queue. This statistic includes meta-samples that represent the unregistration or disposal of an instance.

◆ alive_instance_count

DDS_LongLong DDS_DataWriterCacheStatus::alive_instance_count

The number of instances currently in the DataWriter's queue that have an instance_state equal to DDS_ALIVE_INSTANCE_STATE.

◆ alive_instance_count_peak

DDS_LongLong DDS_DataWriterCacheStatus::alive_instance_count_peak

The highest value of DDS_DataWriterCacheStatus::alive_instance_count over the lifetime of the DataWriter.

◆ disposed_instance_count

DDS_LongLong DDS_DataWriterCacheStatus::disposed_instance_count

The number of instances currently in the DataWriter's queue that have an instance_state equal to DDS_NOT_ALIVE_DISPOSED_INSTANCE_STATE (due to, for example, being disposed via the FooDataWriter_dispose operation).

◆ disposed_instance_count_peak

DDS_LongLong DDS_DataWriterCacheStatus::disposed_instance_count_peak

The highest value of DDS_DataWriterCacheStatus::disposed_instance_count over the lifetime of the DataWriter.

◆ unregistered_instance_count

DDS_LongLong DDS_DataWriterCacheStatus::unregistered_instance_count

The number of instances currently in the DataWriter's queue that the DataWriter has unregistered from via the FooDataWriter_unregister_instance operation.

◆ unregistered_instance_count_peak

DDS_LongLong DDS_DataWriterCacheStatus::unregistered_instance_count_peak

The highest value of DDS_DataWriterCacheStatus::unregistered_instance_count over the lifetime of the DataWriter.