Hook Class Reference

#include "vault/gear/activity.hpp"

Description

Extension point to invoke a callback from Activity activation.

Remarks

referred from the Activity::Verb::HOOK

See also

ActivityDetector primary usage for testing

Definition at line 153 of file activity.hpp.

Public Member Functions
virtual	~Hook ()
	this is an interface
virtual Proc	activation (Activity &thisHook, Time now, void *executionCtx)=0
	Callback on activation of the corresponding HOOK-Activity.
virtual Proc	notify (Activity &thisHook, Time now, void *executionCtx)=0
	Callback when dispatching a NOTIFY-Activity to thisHook.
virtual Time	getDeadline () const =0
virtual std::string	diagnostic () const
	operator std::string () const

Constructor & Destructor Documentation

~Hook()

~Hook ( )

virtual

this is an interface

Definition at line 41 of file activity-lang.cpp.

Member Function Documentation

activation()

virtual Proc activation ( Activity &  thisHook, Time  now, void *  executionCtx  )

pure virtual

Callback on activation of the corresponding HOOK-Activity.

Parameters

thisHook	the Activity record wired to this hook
now	current »wall-clock-time« as used by the Scheduler
executionCtx	opaque pointer to the actual execution context

Returns

decision how to proceed with the activation

Remarks

the intended use is to rig this callback based on additional knowledge regarding the usage context. Through thisHook, the follow-up chain is accessible, and an additional payload data field (size_t). Since the execution context is a concept, it is necessary to know the actual type of the concrete execution context and cast down in the implementation. This mechanism is used especially for detecting expected test invocations.

Implemented in ActivityDetector::ActivityProbe.

Referenced by Activity::callHook().

Here is the caller graph for this function:

notify()

virtual Proc notify ( Activity &  thisHook, Time  now, void *  executionCtx  )

pure virtual

Callback when dispatching a NOTIFY-Activity to thisHook.

Implemented in ActivityDetector::ActivityProbe.

Referenced by Activity::notifyHook().

Here is the caller graph for this function:

getDeadline()

virtual Time getDeadline ( ) const

pure virtual

Implemented in ActivityDetector::ActivityProbe.

Referenced by Activity::postNotify().

Here is the caller graph for this function:

diagnostic()

virtual std::string diagnostic ( ) const

inlinevirtual

Reimplemented in ActivityDetector::ActivityProbe.

Definition at line 183 of file activity.hpp.

Referenced by Hook::operator std::string().

Here is the caller graph for this function:

operator std::string()

operator std::string ( ) const

inline

Definition at line 188 of file activity.hpp.

References Hook::diagnostic().

Here is the call graph for this function:

Inheritance diagram for Hook:

Collaboration diagram for Hook:

---

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

• activity.hpp
• activity-lang.cpp