event_list.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 event_list.h
9 * @date Apr 13, 2017
10 * @brief Event list module header file.
11 *
12 * Various operations can be performed for event lists in this module.
13 *
14 ************************************************************************/
15 
16 #ifndef EVENT_LIST_H_
17 #define EVENT_LIST_H_
18 
19 #include "data_types.h"
20 #include "event.h"
21 
25 typedef struct event_list_t
26 {
27  item_meta_t *meta;
28  list_t *events;
29 } event_list_t;
30 
42 E_MCL_ERROR_CODE event_list_initialize(const char *version, event_list_t **event_list);
43 
56 E_MCL_ERROR_CODE event_list_add_event(event_t *event, event_list_t *event_list);
57 
63 void event_list_destroy(event_list_t **event_list);
64 
65 #endif //event_list_H_
event_list_t::events
list_t * events
Payload of event list.
Definition: event_list.h:28
event_list_destroy
void event_list_destroy(event_list_t **event_list)
To destroy the event_list data struct.
Definition: event_list.c:98
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
item_meta_t
This struct is used for building item.meta structure.
Definition: data_types.h:84
event_list_initialize
E_MCL_ERROR_CODE event_list_initialize(const char *version, event_list_t **event_list)
This function creates and initializes a data struct of event_list.
Definition: event_list.c:23
event_list_t::meta
item_meta_t * meta
Meta of event list.
Definition: event_list.h:27
event_list_t
This struct is used for building the event.
Definition: event_list.h:25
mcl_list_t
Definition: mcl_list.h:40
event.h
Event module header file.
event_t
This struct is used for building a single event.
Definition: event.h:24
event_list_add_event
E_MCL_ERROR_CODE event_list_add_event(event_t *event, event_list_t *event_list)
This function adds event to event_list.
Definition: event_list.c:60
data_types.h
Data types module header file.