libdar::statistics Class Reference
[API]

structure returned by libdar call to give a summary of the operation done in term of file treated More...

#include <statistics.hpp>

List of all members.

Public Member Functions

 statistics (bool lock=true)
 constructor
 ~statistics ()
 destructor
void clear ()
 reset counters to zero
infinint total () const
 total number of file treated
void incr_hard_links ()
 increment by one the treated counter
void incr_skipped ()
 increment by one the hard_links counter
void incr_ignored ()
 increment by one the skipped counter
void incr_tooold ()
 increment by one the ignored counter
void incr_errored ()
 increment by one the tooold counter
void incr_deleted ()
 increment by one the errored counter
void incr_ea_treated ()
 increment by one the deleted counter
void add_to_ignored (const infinint &val)
 increment by one the ea_treated counter
void add_to_errored (const infinint &val)
 increment the ignored counter by a given value
void add_to_deleted (const infinint &val)
 increment the errored counter by a given value
infinint get_treated () const
 increment the deleted counter by a given value
infinint get_hard_links () const
 returns the current value of the treated counter
infinint get_skipped () const
 returns the current value of the hard_links counter
infinint get_ignored () const
 returns the current value of the skipped counter
infinint get_tooold () const
 returns the current value of the ignored counter
infinint get_errored () const
 returns the current value of the tooold counter
infinint get_deleted () const
 returns the current value of the errored counter
infinint get_ea_treated () const
 returns the current value of the deleted counter


Detailed Description

structure returned by libdar call to give a summary of the operation done in term of file treated

the different fields are used for backup, restoration and other operation their meaning changes a bit depending on the operation. Some operation may not use all fields. To have a detailed view of what fields get used and what

Definition at line 67 of file statistics.hpp.


Constructor & Destructor Documentation

libdar::statistics::statistics ( bool  lock = true  )  [inline]

constructor

Parameters:
[in] lock whether to use mutex to manipulate (read or write) variables of that object
Note:
using a statistics object built without lock (false given as argument to the constructor) may lead to application crash if several threads are accessing at the same object at the same time when at least one thread is modifying this object, unless you really know what you are doing, it is better to always use the default value for this constructor or to explicitely give "true" as argument.

Definition at line 77 of file statistics.hpp.

References clear().


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

Generated on Mon Nov 3 23:50:11 2008 for Disk ARchive by  doxygen 1.5.5