Inheritance diagram for HPS.EmergencyHandler:

Classes

class  EmergencyHandlerUnknown
 

Public Member Functions

virtual void Dispose ()
 
delegate void DtorDelegate (IntPtr cPtr)
 
 EmergencyHandler ()
 
 EmergencyHandler (HPS.EmergencyHandler in_that)
 
IntPtr GetClassID ()
 
abstract void Handle (string message, HPS.Emergency.Code code)
 

Protected Member Functions

virtual void deleteCptr ()
 
virtual bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
virtual bool IsUserDerived ()
 

Static Protected Member Functions

static void DtorCallback (IntPtr p)
 

Protected Attributes

bool cMemOwn
 
HandleRef cptr
 

Static Protected Attributes

static Dictionary< IntPtr, EmergencyHandlercachedObjects = new Dictionary<IntPtr, EmergencyHandler>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

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

◆ EmergencyHandler()

HPS.EmergencyHandler.EmergencyHandler ( )
inline

A constructor for an EmergencyHandler.

Member Function Documentation

◆ GetClassID()

IntPtr HPS.EmergencyHandler.GetClassID ( )
inline

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

◆ Handle()

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:
  • internals/hps_core/source/cs/HPS.EmergencyHandler.cs