Fawkes API  Fawkes Development Version
RRDThread Class Reference

RRD Thread. More...

#include "rrd_thread.h"

Inheritance diagram for RRDThread:

List of all members.

Public Member Functions

 RRDThread ()
 Constructor.
virtual ~RRDThread ()
 Destructor.
virtual void init ()
 Initialize the thread.
virtual void loop ()
 Code to execute in the thread.
virtual void finalize ()
 Finalize the thread.
virtual void add_rrd (fawkes::RRDDefinition *rrd_def)
 Add RRD.
virtual void remove_rrd (fawkes::RRDDefinition *rrd_def)
 Remove RRD.
virtual void add_graph (fawkes::RRDGraphDefinition *rrd_graph_def)
 Add graph.
virtual void add_data (const char *rrd_name, const char *format,...)
 Add data.
virtual const
fawkes::RWLockVector
< fawkes::RRDDefinition * > & 
get_rrds () const
 Get RRDs.
virtual const
fawkes::RWLockVector
< fawkes::RRDGraphDefinition * > & 
get_graphs () const
 Get graphs.
void generate_graphs ()
 Generate all graphs.

Protected Member Functions

virtual void run ()
 Stub to see name in backtrace for easier debugging.

Detailed Description

RRD Thread.

This thread maintains an active connection to RRD and provides an aspect to access RRD to make it convenient for other threads to use RRD.

Author:
Tim Niemueller

Constructor & Destructor Documentation

RRDThread::RRDThread ( )

Constructor.

Definition at line 47 of file rrd_thread.cpp.

References fawkes::Thread::set_prepfin_conc_loop().

RRDThread::~RRDThread ( ) [virtual]

Destructor.

Definition at line 57 of file rrd_thread.cpp.


Member Function Documentation

void RRDThread::add_data ( const char *  rrd_name,
const char *  format,
  ... 
) [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.

Implements fawkes::RRDManager.

Definition at line 237 of file rrd_thread.cpp.

References fawkes::RWLockVector::rwlock(), fawkes::RRDDefinition::get_name(), and fawkes::RRDDefinition::get_filename().

void RRDThread::add_graph ( fawkes::RRDGraphDefinition rrd_graph_def) [virtual]

Add graph.

Add a graph definition from which to generate graphs.

Parameters:
rrd_graph_defRRD graph definition

Implements fawkes::RRDManager.

Definition at line 213 of file rrd_thread.cpp.

References fawkes::RRDGraphDefinition::get_name(), fawkes::RRDGraphDefinition::set_filename(), and fawkes::RWLockVector::rwlock().

void RRDThread::finalize ( ) [virtual]

Finalize the thread.

This method is executed just before the thread is canceled and destroyed. It is always preceeded by a call to prepare_finalize(). If this is not the case this is a failure. The condition can be checked with the boolean variable finalize_prepared.

This method is meant to be used in conjunction with aspects and to cover thread inter-dependencies. This routine MUST bring the thread into a safe state such that it may be canceled and destroyed afterwards. If there is any reason that this cannot happen make your prepare_finalize() reports so.

This method is called by the thread manager just before the thread is being cancelled. Here you can do whatever steps are necessary just before the thread is cancelled. Note that you thread is still running and might be in the middle of a loop, so it is not a good place to give up on all resources used. Mind segmentation faults that could happen. Protect the area with a mutex that you lock at the beginning of your loop and free in the end, and that you lock at the beginning of finalize and then never unlock. Also not that the finalization may be canceled afterwards. The next thing that happens is that either the thread is canceled and destroyed or that the finalization is canceled and the thread has to run again.

Finalize is called on a thread just before it is deleted. It is guaranteed to be called on a fully initialized thread (if no exception is thrown in init()) (this guarantee holds in the Fawkes framework).

The default implementation does nothing besides throwing an exception if prepare_finalize() has not been called.

Exceptions:
Exceptionthrown if prepare_finalize() has not been called.
See also:
prepare_finalize()
cancel_finalize()

Reimplemented from fawkes::Thread.

Definition at line 75 of file rrd_thread.cpp.

void RRDThread::generate_graphs ( )

Generate all graphs.

Definition at line 91 of file rrd_thread.cpp.

References fawkes::RWLockVector::rwlock().

Referenced by loop().

const fawkes::RWLockVector< RRDGraphDefinition * > & RRDThread::get_graphs ( ) const [virtual]

Get graphs.

Returns:
vector of all current graph definitions.

Implements fawkes::RRDManager.

Definition at line 291 of file rrd_thread.cpp.

const fawkes::RWLockVector< RRDDefinition * > & RRDThread::get_rrds ( ) const [virtual]

Get RRDs.

Returns:
vector of all current RRD definitions.

Implements fawkes::RRDManager.

Definition at line 284 of file rrd_thread.cpp.

void RRDThread::init ( ) [virtual]

Initialize the thread.

This method is meant to be used in conjunction with aspects. Some parts of the initialization may only happen after some aspect of the thread has been initialized. Implement the init method with these actions. It is guaranteed to be called just after all aspects have been initialized and only once in the lifetime of the thread. Throw an exception if any problem occurs and the thread should not run.

Just because your init() routine suceeds and everything looks fine for this thread does not automatically imply that it will run. If it belongs to a group of threads in a ThreadList and any of the other threads fail to initialize then no thread from this group is run and thus this thread will never run. In that situation finalize() is called for this very instance, prepare_finalize() however is not called.

See also:
Fawkes Thread Aspects

Reimplemented from fawkes::Thread.

Definition at line 63 of file rrd_thread.cpp.

References fawkes::ConfigurableAspect::config, fawkes::Configuration::get_float(), fawkes::ClockAspect::clock, and fawkes::time_sec_to_usec().

void RRDThread::loop ( ) [virtual]

Code to execute in the thread.

Implement this method to hold the code you want to be executed continously. If you do not implement this method, the default is that the thread will exit. This is useful if you choose to only implement once().

Reimplemented from fawkes::Thread.

Definition at line 81 of file rrd_thread.cpp.

References fawkes::TimeWait::mark_start(), generate_graphs(), and fawkes::TimeWait::wait_systime().

void RRDThread::remove_rrd ( fawkes::RRDDefinition rrd_def) [virtual]

Remove RRD.

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

Parameters:
rrd_defRRD definition

Implements fawkes::RRDManager.

Definition at line 186 of file rrd_thread.cpp.

References fawkes::RWLockVector::rwlock(), and fawkes::RRDDefinition::get_name().

virtual void RRDThread::run ( ) [inline, protected, virtual]

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 66 of file rrd_thread.h.


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