<DESCRIPTIOM> More...

#include "services/eloom_sysbase.h"

Include dependency graph for IApplicationErrorDelegateVtbl.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	_IApplicationErrorDelegate_vtbl

struct	_IApplicationErrorDelegate

Typedefs
typedef struct _IApplicationErrorDelegate_vtbl	IApplicationErrorDelegate_vtbl

Functions
SYS_DEFINE_STATIC_INLINE sys_error_code_t	IAEDInit (IApplicationErrorDelegate _this, void pParams)

SYS_DEFINE_STATIC_INLINE sys_error_code_t	IAEDOnStartApplication (IApplicationErrorDelegate _this, ApplicationContext pxContext)

SYS_DEFINE_STATIC_INLINE sys_error_code_t	IAEDProcessEvent (IApplicationErrorDelegate _this, ApplicationContext pxContext, SysEvent xEvent)

SYS_DEFINE_STATIC_INLINE sys_error_code_t	IAEDOnNewErrEvent (IApplicationErrorDelegate *_this, SysEvent xEvent)

SYS_DEFINE_STATIC_INLINE boolean_t	IAEDIsLastErrorPending (IApplicationErrorDelegate *_this)

SYS_DEFINE_STATIC_INLINE sys_error_code_t	IAEDAddFirstResponder (IApplicationErrorDelegate _this, IErrFirstResponder pFirstResponder, uint8_t nPriority)

SYS_DEFINE_STATIC_INLINE sys_error_code_t	IAEDRemoveFirstResponder (IApplicationErrorDelegate _this, IErrFirstResponder pFirstResponder)

SYS_DEFINE_STATIC_INLINE uint8_t	IAEDGetMaxFirstResponderPriority (const IApplicationErrorDelegate *_this)

SYS_DEFINE_STATIC_INLINE void	IAEDResetCounter (IApplicationErrorDelegate *_this)

Detailed Description

Author: STMicroelectronics - ST-Korea - MCD Team

Version: 3.0.0

Date: Aug 4, 2017

Attention

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Typedef Documentation

◆ IApplicationErrorDelegate_vtbl

typedef struct _IApplicationErrorDelegate_vtbl IApplicationErrorDelegate_vtbl

Create type name for _IApplicationErrorDelegate_vtbl.

Function Documentation

◆ IAEDAddFirstResponder()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IAEDAddFirstResponder	(	IApplicationErrorDelegate *	_this,
		IErrFirstResponder *	pFirstResponder,
		uint8_t	nPriority
	)

inline

Add a first responder object. The first responders are grouped in a priority set. Zero is the highest priority. If an IErrFirstResponder object with the same priority was already added, then it is replaced with the new one.

Parameters

_this	[IN] specifies a pointer to an IApplicationErrorDelegate object.
pFirstResponder	[IN] specifies a pointer to the a first responder object. If it is NULL then the IErrFirstResponder with nPriority priority is removed from the application error delegate.
nPriority	[IN] specifies the priority of the error first responder. Zero is the highest priority.

Returns: SYS_NO_ERROR_CODE if success, an error code otherwise.

◆ IAEDGetMaxFirstResponderPriority()

SYS_DEFINE_STATIC_INLINE uint8_t IAEDGetMaxFirstResponderPriority ( const IApplicationErrorDelegate * _this )

inline

Get the highest priority allowed for a first responder object.

Parameters

_this [IN] specifies a pointer to an IApplicationErrorDelegate object.

Returns: he highest priority allowed for a first responder object.

◆ IAEDInit()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IAEDInit	(	IApplicationErrorDelegate *	_this,
		void *	pParams
	)

inline

Initialize the driver. This method should be used by a task object during the hardware initialization process.

Parameters

_this	[IN] specifies a pointer to an IApplicationErrorDelegate object.
pParams	specifies a pointer to a subclass defined initialization parameters.

Returns: SYS_NO_ERROR_CODE if success, an error code otherwise.

◆ IAEDIsLastErrorPending()

SYS_DEFINE_STATIC_INLINE boolean_t IAEDIsLastErrorPending ( IApplicationErrorDelegate * _this )

inline

Used by the AED to notify the system if the last error has been recovered or not.

Parameters

_this [IN] specifies a pointer to an IApplicationErrorDelegate object.

Returns: TRUE if the last error has been recovered, FALSE otherwise

◆ IAEDOnNewErrEvent()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IAEDOnNewErrEvent	(	IApplicationErrorDelegate *	_this,
		SysEvent	xEvent
	)

inline

The INIT task call this method as soon as a new error event is posted by the application. This allows the application error delegate to provide a first respond to critical errors. The application error delegate should notify the first responder objects starting from the highest priority one.

Parameters

_this	[IN] specifies a pointer to an IApplicationErrorDelegate object.
xEvent	xEvent [IN] specifies an error event

Returns: SYS_NO_EROR_CODE if success, an error code otherwise.

◆ IAEDOnStartApplication()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IAEDOnStartApplication	(	IApplicationErrorDelegate *	_this,
		ApplicationContext *	pxContext
	)

inline

Called by the system just before the control is released to the application tasks.

Parameters

_this	[IN] specifies a pointer to an IApplicationErrorDelegate object.
pxContext	[IN] specifies a pointer to the application context.

Returns: SYS_NO_ERROR_CODE if success, an error code otherwise.

◆ IAEDProcessEvent()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IAEDProcessEvent	(	IApplicationErrorDelegate *	_this,
		ApplicationContext *	pxContext,
		SysEvent	xEvent
	)

inline

The INIT task uses this function to deliver an error event to the application error manager delegate object.

Parameters

_this	[IN] specifies a pointer to an IApplicationErrorDelegate object.
pxContext	[IN] specifies a pointer to the application context.
xEvent	[IN] specifies an error event

Returns: SYS_NO_ERROR_CODE if success, an error code otherwise.

◆ IAEDRemoveFirstResponder()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IAEDRemoveFirstResponder	(	IApplicationErrorDelegate *	_this,
		IErrFirstResponder *	pFirstResponder
	)

inline

Remove a first responder object rom the application error delegate.

Parameters

_this	[IN] specifies a pointer to an IApplicationErrorDelegate object.
pFirstResponder	[IN] specifies a pointer to the a first responder object to be removed.

Returns: SYS_NO_ERROR_CODE if success, an error code otherwise.

◆ IAEDResetCounter()

SYS_DEFINE_STATIC_INLINE void IAEDResetCounter ( IApplicationErrorDelegate * _this )

inline

Reset the counter of the AED. Usually an AED use some kind of timeout to check that all managed tasks are working fine. A task should call this method before a critical operation, that is for example a write operation in FLASH or EEPROM, or a long critical section. For convenience the managed task interface has a function IMTResetAEDCounter() that can be used by a task instead of call directly this function.

Parameters

_this [IN] specifies a pointer to an IApplicationErrorDelegate object.

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ IApplicationErrorDelegate_vtbl

Function Documentation

◆ IAEDAddFirstResponder()

◆ IAEDGetMaxFirstResponderPriority()

◆ IAEDInit()

◆ IAEDIsLastErrorPending()

◆ IAEDOnNewErrEvent()

◆ IAEDOnStartApplication()

◆ IAEDProcessEvent()

◆ IAEDRemoveFirstResponder()

◆ IAEDResetCounter()