YAMI4 C++
Public Member Functions | List of all members
yami::activity_statistics_monitor Class Reference

Simple activity statistics monitor. More...

#include <activity_statistics_monitor.h>

Inheritance diagram for yami::activity_statistics_monitor:
yami::event_callback

Public Member Functions

void get (parameters &params, bool reset_counters=false)
 Retrieves all collected statistics. More...
 
void operator() (incoming_message &msg)
 Standard reply to the incoming message. More...
 

Detailed Description

Simple activity statistics monitor.

This class defines the basic stats monitor that is based on the event notification mechanism. The monitor can also be used for remote inspection of the collected data, as it can directly play the role of regular object that implements the "get" command.

Member Function Documentation

◆ get()

void activity_statistics_monitor::get ( parameters params,
bool  reset_counters = false 
)

Retrieves all collected statistics.

Retrieves the collected statistics by filling the given parameters object. Optional atomic reset of the counters is possible.

Parameters
paramsThe parameters object to be filled with data.
reset_countersRequest atomic reset of the counters.

◆ operator()()

void activity_statistics_monitor::operator() ( incoming_message msg)

Standard reply to the incoming message.

Implements the standard reply to the remote "get" command and replies with a parameters object filled with collected statistics.

Parameters
msgIncoming message object.

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