RTI Connext Modern C++ API  Version 6.1.0
dds::core::policy::HistoryKind_def Struct Reference

The definition of the dds::core::safe_enum HistoryKind. More...

#include <PolicyKind.hpp>

Public Types

enum  type {
  KEEP_LAST,
  KEEP_ALL
}
 The underlying enum type. More...
 

Detailed Description

The definition of the dds::core::safe_enum HistoryKind.

Member Enumeration Documentation

◆ type

The underlying enum type.

Enumerator
KEEP_LAST 

[default] Keep the last depth samples.

On the publishing side, RTI Connext will only attempt to keep the most recent depth samples of each instance of data (identified by its key) managed by the dds::pub::DataWriter. Invalid samples representing a disposal or unregistration of an instance count towards the depth and may replace other DDS samples currently in the DataWriter queue for the same instance.

On the subscribing side, the dds::sub::DataReader will only attempt to keep the most recent depth samples received for each instance (identified by its key) until the application takes them via the dds::sub::DataReader 's take() operation.
Invalid samples representing a disposal or unregistration of an instance do not count towards the history depth and will not replace other DDS samples currently in the DataReader queue for the same instance.

KEEP_ALL 

Keep all the samples.

On the publishing side, RTI Connext will attempt to keep all samples (representing each value written) of each instance of data (identified by its key) managed by the dds::pub::DataWriter until they can be delivered to all subscribers.

On the subscribing side, RTI Connext will attempt to keep all samples of each instance of data (identified by its key) managed by the dds::sub::DataReader. These samples are kept until the application takes them from RTI Connext via the take() operation.