rvm  1.11
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
job_path_report Class Reference

Job report for an rsync run on a single path. More...

#include <reporter.h>

Collaboration diagram for job_path_report:
Collaboration graph

Public Member Functions

 job_path_report ()
 C'tor. More...
 
 job_path_report (const job_path_report &a_class)
 C'tor. More...
 
 job_path_report (const std::string a_source, const timer a_time, const uint16 a_exit_code, const uint16 a_signal_num, const rsync_behavior::value_type a_behavior, const std::string a_error_message)
 C'tor. More...
 
 ~job_path_report ()
 D'tor. More...
 
void clear (void)
 Clear all values. More...
 
void assign (const job_path_report &a_class)
 Assignment. More...
 
void assign (const std::string a_source, const timer a_time, const uint16 a_exit_code, const uint16 a_signal_num, const rsync_behavior::value_type a_behavior, const std::string a_error_message)
 Assignment. More...
 
const bool status (void) const
 Return true if rsync succeeded archiving this path. More...
 
void source (const std::string &a_class)
 Set the path archived for this report. More...
 
const std::string & source (void) const
 Return a string of the path archived. More...
 
void time (const timer &a_class)
 Set the timer values for this report. More...
 
const timertime (void) const
 Return the timer object for this report. More...
 
void exit_code (const int a_exit_code)
 Set rsync's return exit code when archiving this path. More...
 
const int exit_code (void) const
 Return rsync's exit code. More...
 
void signal_num (const int a_signal_num)
 Set rsync's signal number from archiving this path. More...
 
const int signal_num (void) const
 Return rsync's signal number. More...
 
const rsync_behavior::value_type behavior (void) const
 
void error_msg (const std::string &a_class)
 Set a descriptive error message for this report. More...
 
const std::string & error_msg (void) const
 Return the error message. More...
 
job_path_reportoperator= (const job_path_report &a_class)
 Assignment operator. More...
 

Private Attributes

std::string m_source
 
timer m_time
 
int m_exit_code
 
int m_signal_num
 
std::string m_error_msg
 
rsync_behavior::value_type m_behavior
 

Detailed Description

Job report for an rsync run on a single path.

Definition at line 86 of file reporter.h.

Constructor & Destructor Documentation

job_path_report::job_path_report ( )

C'tor.

Definition at line 333 of file reporter.cc.

References clear().

Here is the call graph for this function:

job_path_report::job_path_report ( const job_path_report a_class)

C'tor.

Definition at line 339 of file reporter.cc.

References assign(), and clear().

Here is the call graph for this function:

job_path_report::job_path_report ( const std::string  a_source,
const timer  a_time,
const uint16  a_exit_code,
const uint16  a_signal_num,
const rsync_behavior::value_type  a_behavior,
const std::string  a_error_message 
)

C'tor.

Definition at line 346 of file reporter.cc.

References assign(), and clear().

Here is the call graph for this function:

job_path_report::~job_path_report ( )

D'tor.

Definition at line 367 of file reporter.cc.

Member Function Documentation

void job_path_report::assign ( const job_path_report a_class)

Assignment.

Definition at line 383 of file reporter.cc.

References m_behavior, m_error_msg, m_exit_code, m_signal_num, m_source, and m_time.

Referenced by job_path_report(), operator=(), and reportio::parse().

void job_path_report::assign ( const std::string  a_source,
const timer  a_time,
const uint16  a_exit_code,
const uint16  a_signal_num,
const rsync_behavior::value_type  a_behavior,
const std::string  a_error_message 
)

Assignment.

Definition at line 396 of file reporter.cc.

References m_behavior, m_error_msg, m_exit_code, m_signal_num, m_source, m_time, and TRY_nomem.

const rsync_behavior::value_type job_path_report::behavior ( void  ) const
void job_path_report::clear ( void  )

Clear all values.

Definition at line 372 of file reporter.cc.

References timer::clear(), m_behavior, m_error_msg, m_exit_code, m_signal_num, m_source, m_time, and rsync_behavior::retry.

Referenced by job_archiver::clear(), and job_path_report().

Here is the call graph for this function:

void job_path_report::error_msg ( const std::string &  a_class)

Set a descriptive error message for this report.

Definition at line 487 of file reporter.cc.

References m_error_msg, and TRY_nomem.

const std::string & job_path_report::error_msg ( void  ) const

Return the error message.

Definition at line 493 of file reporter.cc.

References m_error_msg.

void job_path_report::exit_code ( const int  a_exit_code)

Set rsync's return exit code when archiving this path.

Definition at line 463 of file reporter.cc.

References m_exit_code.

const int job_path_report::exit_code ( void  ) const

Return rsync's exit code.

Definition at line 469 of file reporter.cc.

References m_exit_code.

job_path_report & job_path_report::operator= ( const job_path_report a_class)

Assignment operator.

Definition at line 499 of file reporter.cc.

References assign().

Here is the call graph for this function:

void job_path_report::signal_num ( const int  a_signal_num)

Set rsync's signal number from archiving this path.

Definition at line 475 of file reporter.cc.

References m_signal_num.

const int job_path_report::signal_num ( void  ) const

Return rsync's signal number.

Definition at line 481 of file reporter.cc.

References m_signal_num.

void job_path_report::source ( const std::string &  a_class)

Set the path archived for this report.

Definition at line 439 of file reporter.cc.

References m_source, and TRY_nomem.

const std::string & job_path_report::source ( void  ) const

Return a string of the path archived.

Definition at line 445 of file reporter.cc.

References m_source.

const bool job_path_report::status ( void  ) const

Return true if rsync succeeded archiving this path.

Definition at line 414 of file reporter.cc.

References m_behavior, m_exit_code, m_signal_num, and rsync_behavior::ok.

void job_path_report::time ( const timer a_class)

Set the timer values for this report.

Definition at line 451 of file reporter.cc.

References m_time, and TRY_nomem.

const timer & job_path_report::time ( void  ) const

Return the timer object for this report.

Definition at line 457 of file reporter.cc.

References m_time.

Member Data Documentation

rsync_behavior::value_type job_path_report::m_behavior
private

Definition at line 134 of file reporter.h.

Referenced by assign(), clear(), and status().

std::string job_path_report::m_error_msg
private

Definition at line 133 of file reporter.h.

Referenced by assign(), clear(), and error_msg().

int job_path_report::m_exit_code
private

Definition at line 131 of file reporter.h.

Referenced by assign(), clear(), exit_code(), and status().

int job_path_report::m_signal_num
private

Definition at line 132 of file reporter.h.

Referenced by assign(), clear(), signal_num(), and status().

std::string job_path_report::m_source
private

Definition at line 129 of file reporter.h.

Referenced by assign(), clear(), and source().

timer job_path_report::m_time
private

Definition at line 130 of file reporter.h.

Referenced by assign(), clear(), and time().


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