Class astutedds::rtps::ReaderHistoryCache

Class astutedds::rtps::ReaderHistoryCache

ClassList > astutedds > rtps > ReaderHistoryCache

History cache for a DataReader. More...

  • #include <writer_history_cache.hpp>

Public Functions

Type Name
ReaderHistoryCache (const GUID_t & reader_guid)
Constructor.
void clear_writer (const GUID_t & writer_guid)
Clear received data for a writer.
SequenceNumber_t get_highest_received (const GUID_t & writer_guid) const
Get the highest consecutive sequence number received.
std::set< uint64_t > get_missing (const GUID_t & writer_guid, const SequenceNumber_t & first_available, const SequenceNumber_t & last_available) const
Get missing sequence numbers for a writer.
void record_received (const GUID_t & writer_guid, const SequenceNumber_t & seq_num, const std::vector< uint8_t > & data)
Record a received sample.

Detailed Description

Tracks received samples and detects missing sequence numbers.

Public Functions Documentation

function ReaderHistoryCache

Constructor. 

explicit astutedds::rtps::ReaderHistoryCache::ReaderHistoryCache (
    const GUID_t & reader_guid
)

Parameters:

  • reader_guid GUID of the owning reader

function clear_writer

Clear received data for a writer. 

void astutedds::rtps::ReaderHistoryCache::clear_writer (
    const GUID_t & writer_guid
)

Parameters:

  • writer_guid GUID of the writer

function get_highest_received

Get the highest consecutive sequence number received. 

SequenceNumber_t astutedds::rtps::ReaderHistoryCache::get_highest_received (
    const GUID_t & writer_guid
) const

Parameters:

  • writer_guid GUID of the writer

Returns:

Highest consecutive sequence number

function get_missing

Get missing sequence numbers for a writer. 

std::set< uint64_t > astutedds::rtps::ReaderHistoryCache::get_missing (
    const GUID_t & writer_guid,
    const SequenceNumber_t & first_available,
    const SequenceNumber_t & last_available
) const

Parameters:

  • writer_guid GUID of the writer
  • first_available First sequence number available at writer
  • last_available Last sequence number available at writer

Returns:

Set of missing sequence numbers

function record_received

Record a received sample. 

void astutedds::rtps::ReaderHistoryCache::record_received (
    const GUID_t & writer_guid,
    const SequenceNumber_t & seq_num,
    const std::vector< uint8_t > & data
)

Parameters:

  • writer_guid GUID of the writer
  • seq_num Sequence number received
  • data Serialized sample data

The documentation for this class was generated from the following file include/astutedds/rtps/writer_history_cache.hpp