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 event.h
9 * @date Sep 26, 2016
10 * @brief Event module header file.
11 *
12 * Meta and payload parts of event type are initialized and filled in this module.
13 *
14 ************************************************************************/
15 
16 #ifndef EVENT_H_
17 #define EVENT_H_
18 
19 #include "data_types.h"
20 
24 typedef struct mcl_event_t
25 {
26  item_meta_t *meta;
27  event_payload_t *payload;
28 } event_t;
29 
45 E_MCL_ERROR_CODE event_initialize(item_meta_t *meta, const char* type, const char *version, mcl_int32_t severity, const char* timestamp, event_t **event);
46 
54 void event_destroy(event_t **event);
55 
56 #endif //EVENT_H_
event_initialize
E_MCL_ERROR_CODE event_initialize(item_meta_t *meta, const char *type, const char *version, mcl_int32_t severity, const char *timestamp, event_t **event)
This function creates and initializes a data struct of event_t.
Definition: event.c:23
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
item_meta_t
This struct is used for building item.meta structure.
Definition: data_types.h:84
event_t::payload
event_payload_t * payload
Payload of event.
Definition: event.h:27
event_t::meta
item_meta_t * meta
Meta of event.
Definition: event.h:26
event_payload_t
This struct is used for building event.payload structure.
Definition: data_types.h:132
event_destroy
void event_destroy(event_t **event)
To destroy the event_t data struct.
Definition: event.c:108
event_t
This struct is used for building a single event.
Definition: event.h:24
mcl_int32_t
int32_t mcl_int32_t
Definition: mcl_common.h:41
data_types.h
Data types module header file.