class CommitStatus

A class for storing information regarding the current phase of commit operations. More...

 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Types

Public Methods


Detailed Description

enum Phase { COMMIT_PHASE_NONE = 0, COMMIT_PHASE_1, COMMIT_PHASE_2, COMMIT_PHASE_3, COMMIT_PHASE_4, COMMIT_PHASE_5, COMMIT_PHASE_DONE }

Phase

 CommitStatus ()

CommitStatus

Default constructor.

void  reset ()

reset

Reset the commit status.

bool  success ()

success

[const]

Test if the current phase has been successful.

Returns: true if the current phase has been successful, otherwise false.

const string&  error_msg ()

error_msg

[const]

Get a string with the current error message.

Returns: a string with the current error message.

void  set_error (const string& error_msg)

set_error

Set the commit status as being in error.

Parameters:

error_msgthe message that describes the error.
CommitStatus::Phase  commit_phase ()

commit_phase

[const]

Get the current commit phase.

Returns: the current commit phase.

void  set_commit_phase (CommitStatus::Phase commit_phase)

set_commit_phase

Set the current commit phase.

Parameters:

commit_phasethe new value of the current commit phase.

Generated by: pavlin on kobe.xorp.net on Wed Jan 7 19:11:12 2009, using kdoc 2.0a54+XORP.