A metric for measuring an integral value. More...

#include <Gauge.h>

Collaboration diagram for beast::insight::Gauge:

[legend]

Public Types
using	value_type = GaugeImpl::value_type

using	difference_type = GaugeImpl::difference_type

Public Member Functions
	Gauge ()
	Create a null metric.

	Gauge (std::shared_ptr< GaugeImpl > const &impl)
	Create the metric reference the specified implementation.

std::shared_ptr< GaugeImpl > const &	impl () const


void	set (value_type value) const
	Set the value on the gauge.

Gauge const &	operator= (value_type value) const


void	increment (difference_type amount) const
	Adjust the value of the gauge.

Gauge const &	operator+= (difference_type amount) const

Gauge const &	operator-= (difference_type amount) const

Gauge const &	operator++ () const

Gauge const &	operator++ (int) const

Gauge const &	operator-- () const

Gauge const &	operator-- (int) const

Private Attributes
std::shared_ptr< GaugeImpl >	m_impl

Detailed Description

A metric for measuring an integral value.

A gauge is an instantaneous measurement of a value, like the gas gauge in a car. The caller directly sets the value, or adjusts it by a specified amount. The value is kept in the client rather than the collector.

This is a lightweight reference wrapper which is cheap to copy and assign. When the last reference goes away, the metric is no longer collected.

Definition at line 20 of file Gauge.h.

Member Typedef Documentation

◆ value_type

using beast::insight::Gauge::value_type = GaugeImpl::value_type

Definition at line 23 of file Gauge.h.

◆ difference_type

using beast::insight::Gauge::difference_type = GaugeImpl::difference_type

Definition at line 24 of file Gauge.h.

Constructor & Destructor Documentation

◆ Gauge() [1/2]

beast::insight::Gauge::Gauge ( )

Create a null metric.

A null metric reports no information.

Definition at line 29 of file Gauge.h.

◆ Gauge() [2/2]

beast::insight::Gauge::Gauge ( std::shared_ptr< GaugeImpl > const & impl )

explicit

Create the metric reference the specified implementation.

Normally this won't be called directly. Instead, call the appropriate factory function in the Collector interface.

See also: Collector.

Definition at line 38 of file Gauge.h.

Member Function Documentation

◆ set()

void beast::insight::Gauge::set ( value_type value ) const

Set the value on the gauge.

A Collector implementation should combine multiple calls to value changes into a single change if the calls occur within a single collection interval.

Definition at line 49 of file Gauge.h.

◆ operator=()

Gauge const & beast::insight::Gauge::operator= ( value_type value ) const

Definition at line 56 of file Gauge.h.

◆ increment()

void beast::insight::Gauge::increment ( difference_type amount ) const

Adjust the value of the gauge.

Definition at line 66 of file Gauge.h.

◆ operator+=()

Gauge const & beast::insight::Gauge::operator+= ( difference_type amount ) const

Definition at line 73 of file Gauge.h.

◆ operator-=()

Gauge const & beast::insight::Gauge::operator-= ( difference_type amount ) const

Definition at line 80 of file Gauge.h.

◆ operator++() [1/2]

Gauge const & beast::insight::Gauge::operator++ ( ) const

Definition at line 87 of file Gauge.h.

◆ operator++() [2/2]

Gauge const & beast::insight::Gauge::operator++ ( int ) const

Definition at line 94 of file Gauge.h.

◆ operator--() [1/2]

Gauge const & beast::insight::Gauge::operator-- ( ) const

Definition at line 101 of file Gauge.h.

◆ operator--() [2/2]

Gauge const & beast::insight::Gauge::operator-- ( int ) const

Definition at line 108 of file Gauge.h.

◆ impl()

std::shared_ptr< GaugeImpl > const & beast::insight::Gauge::impl ( ) const

Definition at line 116 of file Gauge.h.

Member Data Documentation

◆ m_impl

std::shared_ptr<GaugeImpl> beast::insight::Gauge::m_impl

private

Definition at line 122 of file Gauge.h.

Public Types

Public Member Functions

Private Attributes