custom_data.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 custom_data.h
9 * @date Sep 26, 2016
10 * @brief Custom data module header file.
11 *
12 * Meta and payload parts of custom data type are initialized and set by this module.
13 *
14 ************************************************************************/
15 
16 #ifndef CUSTOM_DATA_H_
17 #define CUSTOM_DATA_H_
18 
19 #include "data_types.h"
20 
24 typedef struct mcl_custom_data_t
25 {
26  item_meta_t meta;
27  binary_payload_t payload;
28 } custom_data_t;
29 
43 E_MCL_ERROR_CODE custom_data_initialize(const char *version, const char *type, const char *routing, custom_data_t **custom_data);
44 
50 void custom_data_destroy(custom_data_t **custom_data);
51 
52 #endif //CUSTOM_DATA_H_
custom_data_t::meta
item_meta_t meta
Meta of custom data.
Definition: custom_data.h:26
custom_data_destroy
void custom_data_destroy(custom_data_t **custom_data)
Destroys custom_data.
Definition: custom_data.c:72
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
custom_data_t::payload
binary_payload_t payload
Payload of custom data.
Definition: custom_data.h:27
mcl_custom_data_t
struct mcl_custom_data_t mcl_custom_data_t
This struct is used for building the custom data type.
Definition: mcl_custom_data.h:29
custom_data_initialize
E_MCL_ERROR_CODE custom_data_initialize(const char *version, const char *type, const char *routing, custom_data_t **custom_data)
Initializes custom_data.
Definition: custom_data.c:24
binary_payload_t
This struct is used for building custom_data.payload structure.
Definition: data_types.h:164
custom_data_t
This struct is used for building the custom data type.
Definition: custom_data.h:24
data_types.h
Data types module header file.