< Home

< Table of Contents

REFERENCE MANUAL

HPS.EmergencyHandler Class Referenceabstract

The EmergencyHandler class is the base class for an custom EmergencyHandler. More...

Inheritance diagram for HPS.EmergencyHandler:

Public Member Functions

abstract HPS.EmergencyHandler Clone ()
 This function is used to copy custom EmergencyHandler classes. More...
 
virtual void Dispose ()
 
 EmergencyHandler ()
 A constructor for an EmergencyHandler. More...
 
delegate IntPtr EmergencyHandlerDelegate_0 ()
 
delegate void EmergencyHandlerDelegate_1 (string message, HPS.Emergency.Code code)
 
abstract void Handle (string message, HPS.Emergency.Code code)
 Visualize will call the EmergencyHandler::Handle method if any of the handler-enabling conditions are reached. More...
 

Protected Member Functions

virtual void deleteCptr ()
 

Protected Attributes

bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The EmergencyHandler class is the base class for an custom EmergencyHandler.

An EmergencyHandler allows the developer to provide custom logic to handle 'emergency' situations. For example, one can set a soft memory limit using Database::SetSoftMemoryLimit. If that limit is hit, Visualize will call the EmergencyHandler.An EmergencyHandler is set by calling Database::SetEmergencyHandler. Only one EmergencyHandler can be set on the Database. If you try to set a second handler, the first one will be overwritten.The default emergency handler will print a few diagnostics to stdout (when run in debug mode), but will make no attempt to recover from the emergency condition.

Constructor & Destructor Documentation

HPS.EmergencyHandler.EmergencyHandler ( )

A constructor for an EmergencyHandler.

Member Function Documentation

abstract HPS.EmergencyHandler HPS.EmergencyHandler.Clone ( )
pure virtual

This function is used to copy custom EmergencyHandler classes.

Users that create custom EmergencyHandler classes must override this function to provide the proper copying behavior.

abstract void HPS.EmergencyHandler.Handle ( string  message,
HPS.Emergency.Code  code 
)
pure virtual

Visualize will call the EmergencyHandler::Handle method if any of the handler-enabling conditions are reached.

The Emergency::Code value describes the type of condition.


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