IEventSrc_vtbl.h File Reference

Definition of the IEventSrc virtual functions. More...

#include "services/eloom_sysbase.h"

Include dependency graph for IEventSrc_vtbl.h:

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

Go to the source code of this file.

Data Structures
struct	_IEventSrc_vtbl
struct	_IEventSrc

Functions
SYS_DEFINE_STATIC_INLINE sys_error_code_t	IEventSrcInit (IEventSrc *_this)
SYS_DEFINE_STATIC_INLINE sys_error_code_t	IEventSrcAddEventListener (IEventSrc *_this, IEventListener *pListener)
SYS_DEFINE_STATIC_INLINE sys_error_code_t	IEventSrcRemoveEventListener (IEventSrc *_this, IEventListener *pListener)
SYS_DEFINE_STATIC_INLINE uint32_t	IEventSrcGetMaxListenerCount (const IEventSrc *_this)
SYS_DEFINE_STATIC_INLINE sys_error_code_t	IEventSrcSendEvent (const IEventSrc *_this, const IEvent *pxEvent, void *pvParams)

Detailed Description

Definition of the IEventSrc virtual functions.

Author

STMicroelectronics - ST-Korea - MCD Team

Version

3.0.0

Date

Apr 6, 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.

Function Documentation

IEventSrcAddEventListener()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IEventSrcAddEventListener ( IEventSrc *  _this, IEventListener *  pListener  )

inline

Register a listener with this event source.

Parameters

_this	[IN] specifies a pointer to an IEventSrc object.
pListener	[IN] specifies a pointer to an IEventListener object.

Returns

SYS_NO_ERROR_CODE if success, an subclass specific error code otherwise.

IEventSrcGetMaxListenerCount()

SYS_DEFINE_STATIC_INLINE uint32_t IEventSrcGetMaxListenerCount ( const IEventSrc *  _this )

inline

Get the maximum number of IEventListener that can be registered with this event source.

Parameters

_this

[IN] specifies a pointer to an IEventSrc object.

Returns

the maximum number of IEventListener that can be registered with _this event source

IEventSrcInit()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IEventSrcInit ( IEventSrc *  _this )

inline

Initialize an event source. This function should be called after the

Parameters

_this

[IN] specifies a pointer to an IEventSrc object.

Returns

SYS_NO_ERROR_CODE if success, an subclass specific error code otherwise.

IEventSrcRemoveEventListener()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IEventSrcRemoveEventListener ( IEventSrc *  _this, IEventListener *  pListener  )

inline

Remove a listener from this event source,

Parameters

_this	[IN] specifies a pointer to an IEventSrc object.
pListener	[IN] specifies a pointer to an IEventListener object.

Returns

SYS_NO_ERROR_CODE if success, an subclass specific error code otherwise.

IEventSrcSendEvent()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IEventSrcSendEvent ( const IEventSrc *  _this, const IEvent *  pxEvent, void *  pvParams  )

inline

Send an IEvent to all the registered IEventListener.

Parameters

_this	[IN] specifies a pointer to an IEventSrc object.
pxEvent	[IN] specifies a pointer to an IEvent object.
pvParams	[IN] specifies a generic pointer that can be used by the application extend the semantic Event design pattern.

Returns

SYS_NO_ERROR_CODE if success, an subclass specific error code otherwise.