beast::insight::Counter Class Reference

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

#include <Counter.h>

Collaboration diagram for beast::insight::Counter:

Public Types
using	value_type = CounterImpl::value_type

Public Member Functions
	Counter ()=default
	Create a null metric.
	Counter (std::shared_ptr< CounterImpl > impl)
	Create the metric reference the specified implementation.
std::shared_ptr< CounterImpl >	impl_
void	increment (value_type amount) const
	Increment the counter.
Counter const &	operator+= (value_type amount) const
Counter const &	operator-= (value_type amount) const
Counter const &	operator++ () const
Counter const &	operator++ (int) const
Counter const &	operator-- () const
Counter const &	operator-- (int) const

Detailed Description

A metric for measuring an integral value.

A counter is a gauge calculated at the server. The owner of the counter may increment and decrement the value by an amount.

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 18 of file Counter.h.

Member Typedef Documentation

value_type

using beast::insight::Counter::value_type = CounterImpl::value_type

Definition at line 21 of file Counter.h.

Constructor & Destructor Documentation

Counter() [1/2]

beast::insight::Counter::Counter ( )

default

Create a null metric.

A null metric reports no information.

Counter() [2/2]

beast::insight::Counter::Counter ( std::shared_ptr< CounterImpl > 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 33 of file Counter.h.

Member Function Documentation

increment()

void beast::insight::Counter::increment

(

value_type

amount

)

const

Increment the counter.

Definition at line 40 of file Counter.h.

operator+=()

Counter const & beast::insight::Counter::operator+=

(

value_type

amount

)

const

Definition at line 47 of file Counter.h.

operator-=()

Counter const & beast::insight::Counter::operator-=

(

value_type

amount

)

const

Definition at line 54 of file Counter.h.

operator++() [1/2]

Counter const & beast::insight::Counter::operator++

(

)

const

Definition at line 61 of file Counter.h.

operator++() [2/2]

Counter const & beast::insight::Counter::operator++

(

int

)

const

Definition at line 68 of file Counter.h.

operator--() [1/2]

Counter const & beast::insight::Counter::operator--

(

)

const

Definition at line 75 of file Counter.h.

operator--() [2/2]

Counter const & beast::insight::Counter::operator--

(

int

)

const

Definition at line 82 of file Counter.h.

Member Data Documentation

impl_

std::shared_ptr<CounterImpl> beast::insight::Counter::impl_

private

Definition at line 89 of file Counter.h.