Kea  2.1.7-git
isc::stats::StatContext Struct Reference

Statistics context. More...

#include <context.h>

Public Member Functions

void add (const ObservationPtr &obs)
 Adds a new observation. More...
 
void clear ()
 Removes all observations. More...
 
bool del (const std::string &name)
 Attempts to delete an observation. More...
 
ObservationPtr get (const std::string &name) const
 Attempts to get an observation. More...
 
isc::data::ConstElementPtr getAll () const
 Returns a map with all observations. More...
 
void resetAll ()
 Resets all observations. More...
 
void setMaxSampleAgeAll (const StatsDuration &duration)
 Sets duration for all observations. More...
 
void setMaxSampleCountAll (uint32_t max_samples)
 Sets max sample count for all observations. More...
 
size_t size ()
 Returns the number of observations. More...
 

Detailed Description

Statistics context.

Statistics context is essentially a container used to group statistics related to a given context together. Two examples of such contexts are all statistics related to a given subnet or all statistics related to a given network interface.

Definition at line 31 of file context.h.

Member Function Documentation

◆ add()

void isc::stats::StatContext::add ( const ObservationPtr obs)

Adds a new observation.

Parameters
obsobservation to be added
Exceptions
DuplicateStatif an observation with the same name exists already

Definition at line 30 of file context.cc.

References isc_throw.

◆ clear()

void isc::stats::StatContext::clear ( )

Removes all observations.

Definition at line 56 of file context.cc.

◆ del()

bool isc::stats::StatContext::del ( const std::string &  name)

Attempts to delete an observation.

Parameters
namename of the observation to be deleted
Returns
true if successful, false if no such statistic was found

Definition at line 41 of file context.cc.

◆ get()

ObservationPtr isc::stats::StatContext::get ( const std::string &  name) const

Attempts to get an observation.

Parameters
namename of the statistic
Returns
appropriate Observation object (or NULL)

Definition at line 21 of file context.cc.

◆ getAll()

ConstElementPtr isc::stats::StatContext::getAll ( ) const

Returns a map with all observations.

Returns
map with all observations

Definition at line 70 of file context.cc.

◆ resetAll()

void isc::stats::StatContext::resetAll ( )

Resets all observations.

Definition at line 61 of file context.cc.

◆ setMaxSampleAgeAll()

void isc::stats::StatContext::setMaxSampleAgeAll ( const StatsDuration duration)

Sets duration for all observations.

Parameters
durationvalue to be set for all observations

Definition at line 90 of file context.cc.

◆ setMaxSampleCountAll()

void isc::stats::StatContext::setMaxSampleCountAll ( uint32_t  max_samples)

Sets max sample count for all observations.

Parameters
max_samplesvalue to be set for all observations

Definition at line 81 of file context.cc.

◆ size()

size_t isc::stats::StatContext::size ( )

Returns the number of observations.

Returns
the number of observations

Definition at line 51 of file context.cc.


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