ADTF  3.15.1
IRuntimeHookabstract

The IRuntimeHook interface provides a hook callback interface. More...

Classes

struct  tHookInfo
 Hook Info Struct. More...
 

Public Member Functions

virtual tResult RuntimeHook (const tHookInfo &sHookInfo, const iobject_ptr< IObject > &pObject)=0
 This method will be called at specific stages during runtime operation, see IRuntime::tRuntimeHookId. More...
 

Detailed Description

The IRuntimeHook interface provides a hook callback interface.

This mechanism allows you to react upon changes within the runtime. Use the IRuntime::RegisterHook and IRuntime::UnregisterHook methods to insert your hook into the processing chain. Hooks are called before and after an operation is performed in the runtime.

Definition at line 75 of file runtime_intf.h.

Member Function Documentation

◆ RuntimeHook()

virtual tResult RuntimeHook ( const tHookInfo sHookInfo,
const iobject_ptr< IObject > &  pObject 
)
pure virtual

This method will be called at specific stages during runtime operation, see IRuntime::tRuntimeHookId.

Parameters
sHookInfo[in] The Hook Information what happened.
pObject[in] Optional pointer to the object the Hook Event belongs to
Returns
Standard Result Code.
Return values
ERR_CANCELEDThe hook call will break and no further hook will be called.