RTC Toolkit  2.0.0
Public Attributes | Related Functions | List of all members
rtctk::componentFramework::ComponentMetricsParams Struct Reference

Dynamic parameters for ComponentMetrics. More...

#include <componentMetricsIf.hpp>

Public Attributes

std::optional< std::chrono::milliseconds > counter_poll_interval
 Configures interval used between reading and publishing current counter metrics. More...
 
std::optional< std::chrono::milliseconds > thread_poll_interval
 Configures interval used between reading and publishing current thread metrics. More...
 
std::optional< int > monitor_thread_nice
 Configures nice value of telemetry monitoring thread. More...
 

Related Functions

(Note that these are not member functions.)

bool operator== (ComponentMetricsParams const &lhs, ComponentMetricsParams const &rhs) noexcept
 Equality operator for ComponentMetricsParams. More...
 
bool operator!= (ComponentMetricsParams const &lhs, ComponentMetricsParams const &rhs) noexcept
 Inequality operator for ComponentMetricsParams. More...
 
std::ostream & operator<< (std::ostream &os, ComponentMetricsParams const &params)
 Formatter for ComponentMetricsParams. More...
 

Detailed Description

Dynamic parameters for ComponentMetrics.

Member Data Documentation

◆ counter_poll_interval

std::optional<std::chrono::milliseconds> rtctk::componentFramework::ComponentMetricsParams::counter_poll_interval

Configures interval used between reading and publishing current counter metrics.

◆ monitor_thread_nice

std::optional<int> rtctk::componentFramework::ComponentMetricsParams::monitor_thread_nice

Configures nice value of telemetry monitoring thread.

Valid range is [-20 - 19] where higher value is more nice == lower priority.

◆ thread_poll_interval

std::optional<std::chrono::milliseconds> rtctk::componentFramework::ComponentMetricsParams::thread_poll_interval

Configures interval used between reading and publishing current thread metrics.


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