IEvent.h File Reference

The root class from which all event state objects shall be derived. More...

#include "services/eloom_sysbase.h"

Include dependency graph for IEvent.h:

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

Go to the source code of this file.

Data Structures
struct	_IEvent

Typedefs
typedef struct _IEventSrc	IEventSrc
typedef struct _IEvent	IEvent

Functions
static sys_error_code_t	IEventInit (IEvent *_this, const IEventSrc *pSource)

Detailed Description

The root class from which all event state objects shall be derived.

Author

STMicroelectronics - ST-Korea - MCD Team

Version

3.0.0

Date

Apr 17, 2017

An event is an object that contains information about something that happened in the system at a given moment. An event object is constructed with a link to the EventSrc that has generated it.

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

IEvent

typedef struct _IEvent IEvent

Create type name for _IEvent.

IEventSrc

typedef struct _IEventSrc IEventSrc

Create type name for _IEventSrc.

Function Documentation

IEventInit()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IEventInit ( IEvent *  _this, const IEventSrc *  pSource  )

inlinestatic

Initialize an event. An is initialized when it is linked with the IEventSrc that has generated the event.

Parameters

_this	[IN] specifies an IEvent object
pSource	[IN] specifies the IEventSrc object that has generated teh event.

Returns

SYS_NO_ERROR_CODE if success, an error code otherwise.