Fawkes API  Fawkes Development Version
fawkes::RRDManager Class Referenceabstract

Interface for a RRD connection creator. More...

#include <>>

Inheritance diagram for fawkes::RRDManager:

Public Member Functions

virtual ~RRDManager ()
 Virtual empty destructor. More...
 
virtual void add_rrd (RRDDefinition *rrd_def)=0
 Add RRD. More...
 
virtual void remove_rrd (RRDDefinition *rrd_def)=0
 Remove RRD. More...
 
virtual void add_graph (RRDGraphDefinition *rrd_graph_def)=0
 Add graph. More...
 
virtual void add_data (const char *rrd_name, const char *format,...)=0
 Add data. More...
 
virtual const RWLockVector< RRDDefinition * > & get_rrds () const =0
 Get RRDs. More...
 
virtual const RWLockVector< RRDGraphDefinition * > & get_graphs () const =0
 Get graphs. More...
 

Detailed Description

Interface for a RRD connection creator.

Author
Tim Niemueller

Definition at line 40 of file rrd_manager.h.

Constructor & Destructor Documentation

◆ ~RRDManager()

virtual fawkes::RRDManager::~RRDManager ( )
inlinevirtual

Virtual empty destructor.

Definition at line 44 of file rrd_manager.h.

References add_data(), add_graph(), add_rrd(), get_graphs(), get_rrds(), and remove_rrd().

Member Function Documentation

◆ add_data()

virtual void fawkes::RRDManager::add_data ( const char *  rrd_name,
const char *  format,
  ... 
)
pure virtual

Add data.

Add data to an RRF.

Parameters
rrd_namename of the RRD to add data to
formatformat string. It must have the form TIMESTAMP|N:DATA, where TIMESTAMP|N is either a timestamp (in seconds since the epoch), or the letter N to use the current time. DATA is a concatenation of formats according to man sprintf and concatenated by colons, e.g. 1:2:3:4.5.

Implemented in RRDThread.

Referenced by RRDExampleThread::loop(), ProcRRDThread::loop(), MongoRRDThread::loop(), and ~RRDManager().

◆ add_graph()

virtual void fawkes::RRDManager::add_graph ( RRDGraphDefinition rrd_graph_def)
pure virtual

Add graph.

Add a graph definition from which to generate graphs.

Parameters
rrd_graph_defRRD graph definition

Implemented in RRDThread.

Referenced by ProcRRDThread::finalize(), MongoRRDThread::finalize(), RRDExampleThread::init(), ProcRRDThread::init(), MongoRRDThread::init(), and ~RRDManager().

◆ add_rrd()

virtual void fawkes::RRDManager::add_rrd ( RRDDefinition rrd_def)
pure virtual

Add RRD.

Add an RRD which can then be fed with data using add_data().

Parameters
rrd_defRRD definition

Implemented in RRDThread.

Referenced by ProcRRDThread::finalize(), MongoRRDThread::finalize(), RRDExampleThread::init(), ProcRRDThread::init(), MongoRRDThread::init(), and ~RRDManager().

◆ get_graphs()

virtual const RWLockVector<RRDGraphDefinition *>& fawkes::RRDManager::get_graphs ( ) const
pure virtual

Get graphs.

Returns
vector of all current graph definitions.

Implemented in RRDThread.

Referenced by ~RRDManager().

◆ get_rrds()

virtual const RWLockVector<RRDDefinition *>& fawkes::RRDManager::get_rrds ( ) const
pure virtual

Get RRDs.

Returns
vector of all current RRD definitions.

Implemented in RRDThread.

Referenced by ~RRDManager().

◆ remove_rrd()

virtual void fawkes::RRDManager::remove_rrd ( RRDDefinition rrd_def)
pure virtual

Remove RRD.

Remove a RRD definition. This also removes all associated graphs.

Parameters
rrd_defRRD definition

Implemented in RRDThread.

Referenced by RRDExampleThread::finalize(), ProcRRDThread::finalize(), MongoRRDThread::finalize(), fawkes::RRDDefinition::operator=(), fawkes::RRDDefinition::~RRDDefinition(), and ~RRDManager().


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