node::nsolid::ProcessMetrics Class Reference

Class that allows to retrieve process-wide metrics. More...

#include <nsolid.h>

Classes
struct	MetricsStor
	POD type to store process metrics data. More...

Public Member Functions
	ProcessMetrics ()
	Construct a new Process Metrics object. More...
	~ProcessMetrics ()=default
	Destroy the Process Metrics object. More...
std::string	toJSON ()
	Returns the current N|Solid process-wide metrics in JSON format. More...
int	Get (MetricsStor *stor)
	It retrieves the current N|Solid process-wide metrics. A previous call to Update() is needed. More...
int	Update ()
	Calculates and stores the N|Solid process-wide metrics. More...

Detailed Description

Class that allows to retrieve process-wide metrics.

Constructor & Destructor Documentation

ProcessMetrics()

node::nsolid::ProcessMetrics::ProcessMetrics

(

)

Construct a new Process Metrics object.

~ProcessMetrics()

node::nsolid::ProcessMetrics::~ProcessMetrics ( )

default

Destroy the Process Metrics object.

Member Function Documentation

Get()

int node::nsolid::ProcessMetrics::Get

(

MetricsStor *

stor

)

It retrieves the current N|Solid process-wide metrics. A previous call to Update() is needed.

Parameters

stor	A MetricsStor object where the actual metrics will be written to.

Returns

NSOLID_E_SUCCESS in case of success or a different NSOLID_E_ error value otherwise.

toJSON()

std::string node::nsolid::ProcessMetrics::toJSON

(

)

Returns the current N|Solid process-wide metrics in JSON format.

Returns

std::string

Update()

int node::nsolid::ProcessMetrics::Update

(

)

Calculates and stores the N|Solid process-wide metrics.

Returns

NSOLID_E_SUCCESS in case of success or a different NSOLID_E_ error value otherwise.

---

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

• src/nsolid.h