ODeV framework  v2
Typedefs | Functions
IErrorFirstResponder.h File Reference

Declare the Error first responder interface. More...

#include "systypes.h"
#include "syserror.h"
+ Include dependency graph for IErrorFirstResponder.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef struct _IErrFirstResponder IErrFirstResponder
 

Functions

void IErrFirstResponderSetOwner (IErrFirstResponder *this, void *pxOwner)
 
void * IErrFirstResponderGetOwner (IErrFirstResponder *this)
 
sys_error_code_t IErrorFirstResponderNewError (IErrFirstResponder *this, SysEvent xError, boolean_t bIsCalledFromISR)
 

Detailed Description

Declare the Error first responder interface.

Author
STMicroelectronics - ST-Korea - MCD Team
Version
1.2.0
Date
Aug 11, 2017

A first responder object (IErrFirstResponder) can be used by the application in order to provide a quick response to critical errors.

Attention

© COPYRIGHT 2017 STMicroelectronics

Licensed under MCD-ST Liberty SW License Agreement V2, (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at:

   http://www.st.com/software_license_agreement_liberty_v2

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

◆ IErrFirstResponder

Create type name for _IErrFirstResponder.

Function Documentation

◆ IErrFirstResponderGetOwner()

void* IErrFirstResponderGetOwner ( IErrFirstResponder this)
inline

Get the pointer to this object's owner.

Parameters
this[IN] specifies a pointer to an IErrFirstResponder object.

◆ IErrFirstResponderSetOwner()

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_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.