deBaseCrashRecoveryModule Class Reference

Base Crash Recovery Module. More...

#include <deBaseCrashRecoveryModule.h>

Inheritance diagram for deBaseCrashRecoveryModule:
deBaseModule

List of all members.

Public Member Functions

Constructors and Destructors
 deBaseCrashRecoveryModule (deLoadableModule *loadableModule)
 Creates a new module.
virtual ~deBaseCrashRecoveryModule ()
 Cleans up the module.
Module Management
virtual bool Init ()=0
 Initializes the crash recovery module.
virtual void CleanUp ()=0
 Shuts down the crash recovery module and cleans up.
Management
virtual bool RecoverFromError ()=0
 Takes over the run time in the case of an error.

Detailed Description

Base Crash Recovery Module.

Author:
Plüss Roland
Version:
1.0
Date:
2008 Crash Recovery Modules are responsible for handling errors during the execution of the game engine. If anyone of the single type modules fails the crash recovery module is fired up to allow the user to locate the error and recover from it. Errors in the crash recovery module itself lead to an immediate termination of the engine hence this is the module to pay special attention to in terms of error safeness.

Constructor & Destructor Documentation

deBaseCrashRecoveryModule::deBaseCrashRecoveryModule ( deLoadableModule loadableModule )

Creates a new module.

virtual deBaseCrashRecoveryModule::~deBaseCrashRecoveryModule (  ) [virtual]

Cleans up the module.


Member Function Documentation

virtual void deBaseCrashRecoveryModule::CleanUp (  ) [pure virtual]

Shuts down the crash recovery module and cleans up.

virtual bool deBaseCrashRecoveryModule::Init (  ) [pure virtual]

Initializes the crash recovery module.

virtual bool deBaseCrashRecoveryModule::RecoverFromError (  ) [pure virtual]

Takes over the run time in the case of an error.

The modules has to either provide its own event queues ( in the case of ToolKits ) or to operate the event queues of the deOS object itself. Once the engine has reached a state where execution can continue as before this function has to exit with a true value. If false is returned a non recoverable error is assumed and the engine is shut down gracefully.


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