|
Purpose:
|
Contains data and methods related to journaling operation.
|
|
|
Derivation:
|
AcisJournal : ACIS_OBJECT : -
|
|
|
Filename:
|
kern/kernel/kernapi/api/acis_journal.hxx
|
|
|
Description:
|
AcisJournal object provides methods to get or set scheme and SAT filenames for journaling. It also provides methods to start, end, pause and resume journaling operation. However the direct use of the methods is discouraged and the user is advised to use the equivalent API calls like
api_set_journal_name,
api_start_journal etc. instead.
|
|
|
Constructor:
|
public: AcisJournal::AcisJournal
();
|
|
|
Default constructor. Instantiates an
AcisJournal object with SAT and scheme file names set to ACISJour.
|
|
|
|
|
|
|
public: AcisJournal::AcisJournal
(
|
|
|
const AcisJournal& aj
|
// journal
|
|
|
);
|
|
|
Copy constructor instantiates an
AcisJournal object and copies the values from the AcisJournal object passed as an argument.
|
|
|
|
|
|
Destructor:
|
public: virtual AcisJournal::~AcisJournal
();
|
|
|
Destructor releases the memory allocated for this object when this object goes out of scope.
|
|
|
|
|
|
|
public: void AcisJournal::end_journaling
();
|
|
|
This method is used to end the journaling operation that was started using
start_journaling method. It adds the scheme file footer information and closes the SAT and scheme files. The user is advised to use
api_end_journal instead.
|
|
|
|
|
|
|
public: const char* AcisJournal::get_file_name
() const;
|
|
|
This method is used to retrieve the scheme and SAT file name stored in this object.
|
|
|
|
|
|
|
public: logical AcisJournal::get_status
() const;
|
|
|
This method returns the status of the journaling operation. A value of
TRUE indicates that the journaling operation is on. A value of
FALSE indicates that the journaling operation is off.
|
|
|
|
|
|
|
public: void AcisJournal::set_file_name
(
|
|
|
char* name
|
// journal file name
|
|
|
);
|
|
|
This method is used to set the filename for scheme and sat files. The user is advised to use
api_set_journal_name instead.
|
|
|
|
|
|
|
public: void AcisJournal::set_status
(
|
|
|
logical st
|
// journaling on or off
|
|
|
);
|
|
|
This method is used to set the status of the journaling operation to on or off. A value of
FALSE is used to pause the journaling operation. A value of
TRUE is used to resume the journaling operation that was paused. The user is advised to use
api_pause_journal and
api_resume_journal instead.
|
|
|
|
|
|
|
public: void AcisJournal::start_journaling
();
|
|
|
This method is used to start journaling operation. It opens the SAT and scheme files and adds the header information. It stores the file handler for subsequent journaling by other APIs. The user is advised to use
api_start_journal instead.
|
|
|
|
|
|
Related Fncs:
|
api_end_journal, api_get_journal, api_pause_journal, api_resume_journal, api_set_journal, api_set_journal_name, api_start_journal
|