Overview

Sample Code

Programming Guide

API Reference

Support

HPS.EmergencyHandler Class Referenceabstract

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 HPS::Database::SetSoftMemoryLimit. If that limit is hit, Visualize will call the EmergencyHandler.An EmergencyHandler is set by calling HPS::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. More...

Inheritance diagram for HPS.EmergencyHandler:

Public Member Functions

virtual void Dispose ()
 
 EmergencyHandler ()
 A constructor for an EmergencyHandler. More...
 
delegate void EmergencyHandlerDelegate_0 (string message, HPS.Emergency.Code code)
 
IntPtr GetClassID ()
 Returns a unique identifier that is shared by all objects of the same class. More...
 
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. The Emergency::Code value describes the type of condition. 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 HPS::Database::SetSoftMemoryLimit. If that limit is hit, Visualize will call the EmergencyHandler.An EmergencyHandler is set by calling HPS::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 ( )
inline

A constructor for an EmergencyHandler.

Member Function Documentation

IntPtr HPS.EmergencyHandler.GetClassID ( )
inline

Returns a unique identifier that is shared by all objects of the same class.

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: