Tor  0.4.6.0-alpha-dev
Macros | Functions
metrics_store.h File Reference

Header for lib/metrics/metrics_store.c. More...

#include "lib/buf/buffers.h"
#include "lib/container/smartlist.h"
#include "lib/metrics/metrics_common.h"
#include "lib/metrics/metrics_store_entry.h"

Go to the source code of this file.

Macros

#define metrics_store_free(store)    FREE_AND_NULL(metrics_store_t, metrics_store_free_, (store))
 

Functions

void metrics_store_free_ (metrics_store_t *store)
 
metrics_store_tmetrics_store_new (void)
 
metrics_store_entry_t * metrics_store_add (metrics_store_t *store, metrics_type_t type, const char *name, const char *help)
 
smartlist_tmetrics_store_get_all (const metrics_store_t *store, const char *name)
 
void metrics_store_get_output (const metrics_format_t fmt, const metrics_store_t *store, buf_t *data)
 

Detailed Description

Header for lib/metrics/metrics_store.c.

Definition in file metrics_store.h.

Function Documentation

◆ metrics_store_add()

metrics_store_entry_t* metrics_store_add ( metrics_store_t store,
metrics_type_t  type,
const char *  name,
const char *  help 
)

Add a new metrics entry to the given store and type. The name MUST be the unique identifier. The help string can be omitted.

Definition at line 103 of file metrics_store.c.

Referenced by init_store().

◆ metrics_store_free_()

void metrics_store_free_ ( metrics_store_t store)

Free the given store including all its entries.

Definition at line 79 of file metrics_store.c.

◆ metrics_store_get_all()

smartlist_t* metrics_store_get_all ( const metrics_store_t store,
const char *  name 
)

Find all metrics entry in the given store identified by name. If not found, NULL is returned.

Definition at line 92 of file metrics_store.c.

Referenced by hs_metrics_update_by_service().

◆ metrics_store_get_output()

void metrics_store_get_output ( const metrics_format_t  fmt,
const metrics_store_t store,
buf_t *  data 
)

Set the output of the given store of the format fmt into the given buffer data.

Definition at line 126 of file metrics_store.c.

◆ metrics_store_new()

metrics_store_t* metrics_store_new ( void  )

Return a newly allocated and initialized store of the given type.

Definition at line 68 of file metrics_store.c.