mcl_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 mcl_custom_data.h
9 * @date Jul 27, 2016
10 * @brief Custom data module interface header file.
11 *
12 * Meta and payload parts of custom data type are initialized and set by this module.
13 *
14 ************************************************************************/
15 
16 #ifndef MCL_CUSTOM_DATA_H_
17 #define MCL_CUSTOM_DATA_H_
18 
19 #include "mcl_common.h"
20 
21 #ifdef __cplusplus
22 extern "C"
23 {
24 #endif
25 
30 
34  typedef struct mcl_json_t mcl_json_t;
35 
49 
69  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_custom_data_set_payload(mcl_custom_data_t *custom_data, const mcl_uint8_t *content, mcl_size_t content_size);
70 
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif //MCL_CUSTOM_DATA_H_
struct mcl_json_t mcl_json_t
This struct is used for json handling.
MCL_EXPORT E_MCL_ERROR_CODE mcl_custom_data_set_meta_details(mcl_custom_data_t *custom_data, const mcl_json_t *details)
Adds a custom details object to custom_data.
Definition: custom_data.c:42
#define MCL_EXPORT
Common module interface header file.
MCL_EXPORT E_MCL_ERROR_CODE mcl_custom_data_set_payload(mcl_custom_data_t *custom_data, const mcl_uint8_t *content, mcl_size_t content_size)
Sets payload contents.
Definition: custom_data.c:57
E_MCL_ERROR_CODE
MCL Error code definitions. Every function returning an error code uses this enum values...
Definition: mcl_common.h:137
struct mcl_custom_data_t mcl_custom_data_t
This struct is used for building the custom data type.
uint8_t mcl_uint8_t
Definition: mcl_common.h:43
size_t mcl_size_t
Definition: mcl_common.h:38