Generic time-series ring buffer base template. More...

#include <time_series_buffer.h>

Inheritance diagram for kcenon::monitoring::detail::time_series_ring_buffer< Sample >:

Collaboration diagram for kcenon::monitoring::detail::time_series_ring_buffer< Sample >:

Public Member Functions
	time_series_ring_buffer (size_t max_samples)
	Constructor with maximum sample count.

	time_series_ring_buffer (const time_series_ring_buffer &)=delete

time_series_ring_buffer &	operator= (const time_series_ring_buffer &)=delete

	time_series_ring_buffer (time_series_ring_buffer &&)=delete

time_series_ring_buffer &	operator= (time_series_ring_buffer &&)=delete

void	add_sample (const Sample &sample)

template<typename Duration >
std::vector< Sample >	get_samples (Duration duration) const

std::vector< Sample >	get_samples_since (std::chrono::system_clock::time_point since) const

std::vector< Sample >	get_all_samples () const

common::Result< Sample >	get_latest () const

size_t	size () const noexcept

bool	empty () const noexcept

size_t	capacity () const noexcept

void	clear () noexcept

size_t	memory_footprint () const noexcept

Private Member Functions
size_t	get_actual_index (size_t logical_index) const noexcept

Private Attributes
std::mutex	mutex_

std::vector< Sample >	buffer_

size_t	head_ = 0

size_t	count_ = 0

size_t	max_samples_

Detailed Description

template<typename Sample>
class kcenon::monitoring::detail::time_series_ring_buffer< Sample >

Generic time-series ring buffer base template.

This template provides the common ring buffer functionality shared by time_series_buffer<T> and load_average_history. It handles:

Ring buffer storage and index management
Thread-safe add/get operations
Time-based sample filtering

Template Parameters

Sample The sample type (must have a 'timestamp' member of type std::chrono::system_clock::time_point)

Definition at line 194 of file time_series_buffer.h.

Constructor & Destructor Documentation

◆ time_series_ring_buffer() [1/3]

template<typename Sample >

kcenon::monitoring::detail::time_series_ring_buffer< Sample >::time_series_ring_buffer ( size_t max_samples )

inlineexplicit

Constructor with maximum sample count.

Parameters

max_samples Maximum number of samples to store

Exceptions

std::invalid_argument if max_samples is zero

Definition at line 215 of file time_series_buffer.h.

                                                         : max_samples_(max_samples) {
        if (max_samples_ == 0) {
            throw std::invalid_argument("Max samples must be positive");
        }
        buffer_.resize(max_samples_);
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::buffer_, and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::max_samples_.

◆ time_series_ring_buffer() [2/3]

template<typename Sample >

kcenon::monitoring::detail::time_series_ring_buffer< Sample >::time_series_ring_buffer ( const time_series_ring_buffer< Sample > & )

delete

◆ time_series_ring_buffer() [3/3]

template<typename Sample >

kcenon::monitoring::detail::time_series_ring_buffer< Sample >::time_series_ring_buffer ( time_series_ring_buffer< Sample > && )

delete

Member Function Documentation

◆ add_sample()

template<typename Sample >

void kcenon::monitoring::detail::time_series_ring_buffer< Sample >::add_sample ( const Sample & sample )

inline

Definition at line 227 of file time_series_buffer.h.

                                          {
        std::lock_guard<std::mutex> lock(mutex_);
 
        buffer_[head_] = sample;
        head_ = (head_ + 1) % max_samples_;
 
        if (count_ < max_samples_) {
            ++count_;
        }
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::buffer_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::count_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::head_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::max_samples_, and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::mutex_.

◆ capacity()

template<typename Sample >

size_t kcenon::monitoring::detail::time_series_ring_buffer< Sample >::capacity ( ) const

inlinenoexcept

Definition at line 305 of file time_series_buffer.h.

305{ return max_samples_; }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::max_samples_.

◆ clear()

template<typename Sample >

void kcenon::monitoring::detail::time_series_ring_buffer< Sample >::clear ( )

inlinenoexcept

Definition at line 307 of file time_series_buffer.h.

                          {
        std::lock_guard<std::mutex> lock(mutex_);
        head_ = 0;
        count_ = 0;
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::count_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::head_, and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::mutex_.

◆ empty()

template<typename Sample >

bool kcenon::monitoring::detail::time_series_ring_buffer< Sample >::empty ( ) const

inlinenoexcept

Definition at line 300 of file time_series_buffer.h.

                                {
        std::lock_guard<std::mutex> lock(mutex_);
        return count_ == 0;
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::count_, and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::mutex_.

◆ get_actual_index()

template<typename Sample >

size_t kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_actual_index ( size_t logical_index ) const

inlineprivatenoexcept

Definition at line 202 of file time_series_buffer.h.

                                                                 {
        if (count_ < max_samples_) {
            return logical_index;
        }
        return (head_ + logical_index) % max_samples_;
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::count_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::head_, and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::max_samples_.

Referenced by kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_all_samples(), and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_samples_since().

Here is the caller graph for this function:

◆ get_all_samples()

template<typename Sample >

std::vector< Sample > kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_all_samples ( ) const

inline

Definition at line 266 of file time_series_buffer.h.

                                              {
        std::lock_guard<std::mutex> lock(mutex_);
 
        std::vector<Sample> result;
        result.reserve(count_);
 
        for (size_t i = 0; i < count_; ++i) {
            result.push_back(buffer_[get_actual_index(i)]);
        }
 
        std::sort(result.begin(), result.end(),
                  [](const Sample& a, const Sample& b) {
                      return a.timestamp < b.timestamp;
                  });
 
        return result;
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::buffer_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::count_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_actual_index(), and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::mutex_.

Here is the call graph for this function:

◆ get_latest()

template<typename Sample >

common::Result< Sample > kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_latest ( ) const

inline

Definition at line 284 of file time_series_buffer.h.

                                            {
        std::lock_guard<std::mutex> lock(mutex_);
 
        if (count_ == 0) {
            return common::Result<Sample>::err(error_info(monitoring_error_code::collection_failed, "No samples available").to_common_error());
        }
 
        size_t latest_idx = (head_ == 0) ? max_samples_ - 1 : head_ - 1;
        return common::ok(buffer_[latest_idx]);
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::buffer_, kcenon::monitoring::collection_failed, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::count_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::head_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::max_samples_, and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::mutex_.

◆ get_samples()

template<typename Sample >

template<typename Duration >

std::vector< Sample > kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_samples ( Duration duration ) const

inline

Definition at line 239 of file time_series_buffer.h.

                                                           {
        auto cutoff = std::chrono::system_clock::now() - duration;
        return get_samples_since(cutoff);
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_samples_since().

Here is the call graph for this function:

◆ get_samples_since()

template<typename Sample >

std::vector< Sample > kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_samples_since ( std::chrono::system_clock::time_point since ) const

inline

Definition at line 244 of file time_series_buffer.h.

                                                     {
        std::lock_guard<std::mutex> lock(mutex_);
 
        std::vector<Sample> result;
        result.reserve(count_);
 
        for (size_t i = 0; i < count_; ++i) {
            const auto& sample = buffer_[get_actual_index(i)];
            if (sample.timestamp >= since) {
                result.push_back(sample);
            }
        }
 
        std::sort(result.begin(), result.end(),
                  [](const Sample& a, const Sample& b) {
                      return a.timestamp < b.timestamp;
                  });
 
        return result;
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::buffer_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::count_, kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_actual_index(), and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::mutex_.

Referenced by kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_samples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ memory_footprint()

template<typename Sample >

size_t kcenon::monitoring::detail::time_series_ring_buffer< Sample >::memory_footprint ( ) const

inlinenoexcept

Definition at line 313 of file time_series_buffer.h.

                                             {
        return sizeof(time_series_ring_buffer<Sample>) +
               max_samples_ * sizeof(Sample);
    }

References kcenon::monitoring::detail::time_series_ring_buffer< Sample >::max_samples_.

◆ operator=() [1/2]

template<typename Sample >

time_series_ring_buffer & kcenon::monitoring::detail::time_series_ring_buffer< Sample >::operator= ( const time_series_ring_buffer< Sample > & )

delete

◆ operator=() [2/2]

template<typename Sample >

time_series_ring_buffer & kcenon::monitoring::detail::time_series_ring_buffer< Sample >::operator= ( time_series_ring_buffer< Sample > && )

delete

◆ size()

template<typename Sample >

size_t kcenon::monitoring::detail::time_series_ring_buffer< Sample >::size ( ) const

inlinenoexcept

Definition at line 295 of file time_series_buffer.h.

                                 {
        std::lock_guard<std::mutex> lock(mutex_);
        return count_;
    }

Referenced by kcenon::monitoring::detail::time_series_ring_buffer< Sample >::add_sample(), kcenon::monitoring::detail::time_series_ring_buffer< Sample >::clear(), kcenon::monitoring::detail::time_series_ring_buffer< Sample >::empty(), kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_all_samples(), kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_latest(), kcenon::monitoring::detail::time_series_ring_buffer< Sample >::get_samples_since(), and kcenon::monitoring::detail::time_series_ring_buffer< Sample >::size().

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

include/kcenon/monitoring/utils/time_series_buffer.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ time_series_ring_buffer() [1/3]

◆ time_series_ring_buffer() [2/3]

◆ time_series_ring_buffer() [3/3]

Member Function Documentation

◆ add_sample()

◆ capacity()

◆ clear()

◆ empty()

◆ get_actual_index()

◆ get_all_samples()

◆ get_latest()

◆ get_samples()

◆ get_samples_since()

◆ memory_footprint()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ size()

Member Data Documentation

◆ buffer_

◆ count_

◆ head_

◆ max_samples_

◆ mutex_