#include <cinostaskextmpl.h>

Inheritance diagram for CINOSTaskExCmdHookBase:

Public Types
typedef bool(CINOSTaskEx::*	tPreDispatchFunctionBase) (CINOSTaskExMsg *apMsg)
	Base type of pre-dispatch functions. Functions of this type can be used as a callback in SetPreDispatcher.

typedef void(CINOSTaskEx::*	tOnMsgDoneFunctionBase) (CINOSTaskExMsg *apMsg, CINOSTaskExDef::ERplId aRplId, tMcAppError aAppError)
	Base type of OnMsgDone functions. Functions of this type can be used as a callback in SetOnMsgDone.

Public Member Functions
const char *	GetName () const
	Returns the name of the hook.

int	operator< (CINOSTaskExCmdHookBase &aHook)
	binary tree operators

int	operator== (CINOSTaskExCmdHookBase &aHook)

int	operator< (const char *aName)

int	operator== (const char *aName)

virtual tPreDispatchFunctionBase	GetPreDispatchFunction () const =0
	Returns the pre-dispatch hook function if it is set and if the task calling it is of the same type or inherited type of the hook task type. Returns nullptr otherwise.

virtual tOnMsgDoneFunctionBase	GetOnMsgDoneFunction () const =0
	Returns the on-msg-done hook function if it is set and if the task calling it is of the same type or inherited type of the hook task type. Returns nullptr otherwise.

virtual	~CINOSTaskExCmdHookBase ()
	virtual destructor to avoid compiler warning

Protected Member Functions
	CINOSTaskExCmdHookBase (const char *apName, CINOSTaskEx &aTask)
	Constructor (base constructor is protected, as this class is abstract)

Detailed Description

Abstract base class for all CINOSTaskEx command hook templates (TINOSTaskExCmdHook)

Member Typedef Documentation

◆ tOnMsgDoneFunctionBase

typedef void(CINOSTaskEx::* CINOSTaskExCmdHookBase::tOnMsgDoneFunctionBase) (CINOSTaskExMsg *apMsg, CINOSTaskExDef::ERplId aRplId, tMcAppError aAppError)

Base type of OnMsgDone functions. Functions of this type can be used as a callback in SetOnMsgDone.

Parameters

apMsg	CINOSTaskExMsg* the message that MsgDone was called on.
apMsg	aRplId CINOSTaskExDef::ERplId reply id provided to MsgDone.
apMsg	aAppError tMcAppError error code provided to MsgDone.

◆ tPreDispatchFunctionBase

typedef bool(CINOSTaskEx::* CINOSTaskExCmdHookBase::tPreDispatchFunctionBase) (CINOSTaskExMsg *apMsg)

Base type of pre-dispatch functions. Functions of this type can be used as a callback in SetPreDispatcher.

Parameters

apMsg CINOSTaskExMsg* the message that is about to be dispatched.

Member Function Documentation

◆ GetOnMsgDoneFunction()

virtual tOnMsgDoneFunctionBase CINOSTaskExCmdHookBase::GetOnMsgDoneFunction ( ) const

pure virtual

Returns the on-msg-done hook function if it is set and if the task calling it is of the same type or inherited type of the hook task type. Returns nullptr otherwise.

Implemented in TINOSTaskExCmdHook< ObjectType >.

◆ GetPreDispatchFunction()

virtual tPreDispatchFunctionBase CINOSTaskExCmdHookBase::GetPreDispatchFunction ( ) const

pure virtual

Returns the pre-dispatch hook function if it is set and if the task calling it is of the same type or inherited type of the hook task type. Returns nullptr otherwise.

Implemented in TINOSTaskExCmdHook< ObjectType >.

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

/home/jenkins/workspace/inos_doxygen/os/inos/inc/cinostaskextmpl.h

Public Types

Public Member Functions