roo_monitoring
API Documentation for roo_monitoring
Loading...
Searching...
No Matches
Public Member Functions
roo_monitoring::VaultIterator Class Reference

Iterator that scans monitoring data at a given resolution. More...

#include <roo_monitoring.h>

Public Member Functions

 VaultIterator (const Collection *collection, int64_t start, Resolution resolution)
 Creates iterator over collection at resolution, starting at start.
 
int64_t cursor () const
 Returns current iterator timestamp.
 
void next (std::vector< Sample > *sample)
 Advances by one resolution step and fills sample.
 

Detailed Description

Iterator that scans monitoring data at a given resolution.

Starts at a specified timestamp and reads across vault files. Missing vault ranges yield empty samples.

Definition at line 111 of file roo_monitoring.h.

Constructor & Destructor Documentation

◆ VaultIterator()

roo_monitoring::VaultIterator::VaultIterator ( const Collection *  collection,
int64_t  start,
Resolution  resolution 
)

Creates iterator over collection at resolution, starting at start.

Start timestamp is rounded down to resolution boundary.

Definition at line 440 of file monitoring.cpp.

References roo_monitoring::VaultFileReader::open(), and roo_monitoring::VaultFileReader::seekForward().

Member Function Documentation

◆ cursor()

int64_t roo_monitoring::VaultIterator::cursor ( ) const

Returns current iterator timestamp.

Definition at line 460 of file monitoring.cpp.

References roo_monitoring::VaultFileReader::index(), and roo_monitoring::VaultFileRef::timestamp_at().

◆ next()

void roo_monitoring::VaultIterator::next ( std::vector< Sample > *  sample)

Advances by one resolution step and fills sample.

Definition at line 449 of file monitoring.cpp.

References roo_monitoring::VaultFileRef::next(), roo_monitoring::VaultFileReader::next(), roo_monitoring::VaultFileReader::open(), roo_monitoring::VaultFileReader::past_eof(), and roo_monitoring::VaultFileRef::timestamp().

The documentation for this class was generated from the following files: