kcenon::monitoring::moving_window_aggregator< T > Class Template Reference

Time-windowed value collection. More...

#include <stream_aggregator.h>

Collaboration diagram for kcenon::monitoring::moving_window_aggregator< T >:

Classes
struct	entry

Public Types
using	time_point = std::chrono::system_clock::time_point
using	duration = std::chrono::system_clock::duration

Public Member Functions
	moving_window_aggregator (std::chrono::milliseconds window_duration, size_t max_size)
	Constructor.
void	add_value (const T &value, time_point timestamp)
	Add a value with timestamp.
size_t	size () const
	Get current size.
bool	empty () const
	Check if empty.
std::vector< T >	get_values () const
	Get all values in the window.
void	clear ()
	Clear all entries.

Private Member Functions
void	expire_old_entries (time_point current)

Private Attributes
std::shared_mutex	mutex_
std::chrono::milliseconds	window_duration_
size_t	max_size_
std::deque< entry >	entries_

Detailed Description

template<typename T>
class kcenon::monitoring::moving_window_aggregator< T >

Time-windowed value collection.

Maintains a sliding window of values with automatic expiration.

Template Parameters

T	The value type

Definition at line 396 of file stream_aggregator.h.

Member Typedef Documentation

duration

template<typename T >

using kcenon::monitoring::moving_window_aggregator< T >::duration = std::chrono::system_clock::duration

Definition at line 399 of file stream_aggregator.h.

time_point

template<typename T >

using kcenon::monitoring::moving_window_aggregator< T >::time_point = std::chrono::system_clock::time_point

Definition at line 398 of file stream_aggregator.h.

Constructor & Destructor Documentation

moving_window_aggregator()

template<typename T >

kcenon::monitoring::moving_window_aggregator< T >::moving_window_aggregator ( std::chrono::milliseconds window_duration, size_t max_size )

inline

Constructor.

Parameters

window_duration	Duration of the sliding window
max_size	Maximum number of elements

Definition at line 406 of file stream_aggregator.h.

        : window_duration_(window_duration)
        , max_size_(max_size) {}

Member Function Documentation

add_value()

template<typename T >

void kcenon::monitoring::moving_window_aggregator< T >::add_value ( const T & value, time_point timestamp )

inline

Add a value with timestamp.

Parameters

value	The value to add
timestamp	The timestamp

Definition at line 416 of file stream_aggregator.h.

                                                         {
        std::unique_lock<std::shared_mutex> lock(mutex_);
 
        // Remove expired entries
        expire_old_entries(timestamp);
 
        // Add new entry
        if (entries_.size() >= max_size_) {
            entries_.pop_front();
        }
        entries_.push_back({value, timestamp});
    }

References kcenon::monitoring::moving_window_aggregator< T >::entries_, kcenon::monitoring::moving_window_aggregator< T >::expire_old_entries(), kcenon::monitoring::moving_window_aggregator< T >::max_size_, and kcenon::monitoring::moving_window_aggregator< T >::mutex_.

Referenced by TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

template<typename T >

void kcenon::monitoring::moving_window_aggregator< T >::clear ( )

inline

Clear all entries.

Definition at line 461 of file stream_aggregator.h.

                 {
        std::unique_lock<std::shared_mutex> lock(mutex_);
        entries_.clear();
    }

References kcenon::monitoring::moving_window_aggregator< T >::entries_, and kcenon::monitoring::moving_window_aggregator< T >::mutex_.

empty()

template<typename T >

bool kcenon::monitoring::moving_window_aggregator< T >::empty ( ) const

inline

Check if empty.

Definition at line 440 of file stream_aggregator.h.

                       {
        std::shared_lock<std::shared_mutex> lock(mutex_);
        return entries_.empty();
    }

References kcenon::monitoring::moving_window_aggregator< T >::entries_, and kcenon::monitoring::moving_window_aggregator< T >::mutex_.

expire_old_entries()

template<typename T >

void kcenon::monitoring::moving_window_aggregator< T >::expire_old_entries ( time_point current )

inlineprivate

Definition at line 472 of file stream_aggregator.h.

                                                {
        auto cutoff = current - window_duration_;
        while (!entries_.empty() && entries_.front().timestamp < cutoff) {
            entries_.pop_front();
        }
    }

References kcenon::monitoring::moving_window_aggregator< T >::entries_, and kcenon::monitoring::moving_window_aggregator< T >::window_duration_.

Referenced by kcenon::monitoring::moving_window_aggregator< T >::add_value().

Here is the caller graph for this function:

get_values()

template<typename T >

std::vector< T > kcenon::monitoring::moving_window_aggregator< T >::get_values ( ) const

inline

Get all values in the window.

Definition at line 448 of file stream_aggregator.h.

                                    {
        std::shared_lock<std::shared_mutex> lock(mutex_);
        std::vector<T> result;
        result.reserve(entries_.size());
        for (const auto& entry : entries_) {
            result.push_back(entry.value);
        }
        return result;
    }

References kcenon::monitoring::moving_window_aggregator< T >::entries_, kcenon::monitoring::moving_window_aggregator< T >::mutex_, and kcenon::monitoring::moving_window_aggregator< T >::entry::value.

Referenced by TEST_F(), and TEST_F().

Here is the caller graph for this function:

size()

template<typename T >

size_t kcenon::monitoring::moving_window_aggregator< T >::size ( ) const

inline

Get current size.

Definition at line 432 of file stream_aggregator.h.

                        {
        std::shared_lock<std::shared_mutex> lock(mutex_);
        return entries_.size();
    }

References kcenon::monitoring::moving_window_aggregator< T >::entries_, and kcenon::monitoring::moving_window_aggregator< T >::mutex_.

Referenced by TEST_F().

Here is the caller graph for this function:

Member Data Documentation

entries_

template<typename T >

std::deque<entry> kcenon::monitoring::moving_window_aggregator< T >::entries_

private

Definition at line 482 of file stream_aggregator.h.

Referenced by kcenon::monitoring::moving_window_aggregator< T >::add_value(), kcenon::monitoring::moving_window_aggregator< T >::clear(), kcenon::monitoring::moving_window_aggregator< T >::empty(), kcenon::monitoring::moving_window_aggregator< T >::expire_old_entries(), kcenon::monitoring::moving_window_aggregator< T >::get_values(), and kcenon::monitoring::moving_window_aggregator< T >::size().

max_size_

template<typename T >

size_t kcenon::monitoring::moving_window_aggregator< T >::max_size_

private

Definition at line 481 of file stream_aggregator.h.

Referenced by kcenon::monitoring::moving_window_aggregator< T >::add_value().

mutex_

template<typename T >

std::shared_mutex kcenon::monitoring::moving_window_aggregator< T >::mutex_

mutableprivate

Definition at line 479 of file stream_aggregator.h.

Referenced by kcenon::monitoring::moving_window_aggregator< T >::add_value(), kcenon::monitoring::moving_window_aggregator< T >::clear(), kcenon::monitoring::moving_window_aggregator< T >::empty(), kcenon::monitoring::moving_window_aggregator< T >::get_values(), and kcenon::monitoring::moving_window_aggregator< T >::size().

window_duration_

template<typename T >

std::chrono::milliseconds kcenon::monitoring::moving_window_aggregator< T >::window_duration_

private

Definition at line 480 of file stream_aggregator.h.

Referenced by kcenon::monitoring::moving_window_aggregator< T >::expire_old_entries().

---

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

• include/kcenon/monitoring/utils/stream_aggregator.h