mcl_event.h
Go to the documentation of this file.
1 /*!**********************************************************************
2 *
3 * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
4 * All rights reserved.
5 *
6 *************************************************************************
7 *
8 * @file mcl_event.h
9 * @date Jul 27, 2016
10 * @brief Event module interface header file.
11 *
12 ************************************************************************/
13 
14 #ifndef MCL_EVENT_H_
15 #define MCL_EVENT_H_
16 
17 #include "mcl/mcl_common.h"
18 
19 #ifdef __cplusplus
20 extern "C"
21 {
22 #endif
23 
27  typedef struct mcl_event_t mcl_event_t;
28 
43  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_event_set_option(mcl_event_t *event, E_MCL_EVENT_OPTION option, const void *value);
44 
45 #ifdef __cplusplus
46 }
47 #endif
48 
49 #endif //MCL_EVENT_H_
MCL_EXPORT
#define MCL_EXPORT
Definition: mcl_config_setup.h:43
mcl_common.h
Common module interface header file.
E_MCL_EVENT_OPTION
E_MCL_EVENT_OPTION
Optional parameters for event.
Definition: mcl_common.h:125
mcl_event_t
struct mcl_event_t mcl_event_t
This struct is used for building only one message of event.
Definition: mcl_event.h:27
E_MCL_ERROR_CODE
E_MCL_ERROR_CODE
MCL Error code definitions. Every function returning an error code uses this enum values...
Definition: mcl_common.h:137
mcl_event_set_option
MCL_EXPORT E_MCL_ERROR_CODE mcl_event_set_option(mcl_event_t *event, E_MCL_EVENT_OPTION option, const void *value)
This function is used to set optional payload fields of event.
Definition: event.c:77