IErrorFirstResponderVtbl.h File Reference

<DESCRIPTIOM> More...

#include "services/IErrorFirstResponder.h"

Include dependency graph for IErrorFirstResponderVtbl.h:

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

Go to the source code of this file.

Data Structures
struct	_IErrFirstResponder_vtbl
struct	_IErrFirstResponder

Typedefs
typedef struct _IErrFirstResponder_vtbl	IErrFirstResponder_vtbl

Functions
SYS_DEFINE_STATIC_INLINE void	IErrFirstResponderSetOwner (IErrFirstResponder *_this, void *pxOwner)
SYS_DEFINE_STATIC_INLINE void *	IErrFirstResponderGetOwner (IErrFirstResponder *_this)
SYS_DEFINE_STATIC_INLINE sys_error_code_t	IErrorFirstResponderNewError (IErrFirstResponder *_this, SysEvent xError, boolean_t bIsCalledFromISR)

Detailed Description

<DESCRIPTIOM>

Author

STMicroelectronics - ST-Korea - MCD Team

Version

3.0.0

Date

Aug 11, 2017

Attention

Copyright (c) 2017 STMicroelectronics. All rights reserved.

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

IErrFirstResponder_vtbl

typedef struct _IErrFirstResponder_vtbl IErrFirstResponder_vtbl

Create type name for _IErrFirstResponder.

Function Documentation

IErrFirstResponderGetOwner()

SYS_DEFINE_STATIC_INLINE void * IErrFirstResponderGetOwner ( IErrFirstResponder *  _this )

inline

Get the pointer to this object's owner.

Parameters

_this

[IN] specifies a pointer to an IErrFirstResponder object.

IErrFirstResponderSetOwner()

SYS_DEFINE_STATIC_INLINE void IErrFirstResponderSetOwner ( IErrFirstResponder *  _this, void *  pxOwner  )

inline

Set the owner of the listener.

Parameters

_this	[IN] specifies a pointer to an IErrFirstResponder object.
pxOwner	[IN] specifies a pointer to an application specific object that become the owner of this error first responder.

IErrorFirstResponderNewError()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IErrorFirstResponderNewError ( IErrFirstResponder *  _this, SysEvent  xError, boolean_t  bIsCalledFromISR  )

inline

Implement a first response to an error. This method is called by the application error delegate as soon as an error is detected. The implementation must be short and do only a time critical things related to the error. Other error related stuff will be performed in a second time.

Parameters

_this	[IN] specifies a pointer to an IErrFirstResponder object.
xError	[IN] specifies the occurred error.
bIsCalledFromISR	[IN] it is TRUE if the method is called from an ISR call stack, FALSE otherwise.

Returns

SYS_NO_ERROR_CODE if success, an error code otherwise.