mcl_stream_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_stream_data.h
9 * @date Dec 26, 2016
10 * @brief Stream data module interface header file.
11 *
12 ************************************************************************/
13 
14 #ifndef MCL_STREAM_DATA_H_
15 #define MCL_STREAM_DATA_H_
16 
17 #include "mcl_common.h"
18 
19 #ifdef __cplusplus
20 extern "C"
21 {
22 #endif
23 
27  typedef struct mcl_json_t mcl_json_t;
28 
36  typedef mcl_size_t (*mcl_stream_data_read_callback_t)(void *destination, void *source, mcl_size_t size, void *user_context);
37 
41  typedef struct mcl_stream_data_t mcl_stream_data_t;
42 
55  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_stream_data_set_meta_details(mcl_stream_data_t *stream_data, const mcl_json_t *details);
56 
57 #ifdef __cplusplus
58 }
59 #endif
60 
61 #endif //MCL_STREAM_DATA_H_
mcl_json_t
struct mcl_json_t mcl_json_t
This struct is used for json handling.
Definition: mcl_custom_data.h:34
mcl_stream_data_set_meta_details
MCL_EXPORT E_MCL_ERROR_CODE mcl_stream_data_set_meta_details(mcl_stream_data_t *stream_data, const mcl_json_t *details)
Adds a custom details object to stream_data.
Definition: stream_data.c:43
MCL_EXPORT
#define MCL_EXPORT
Definition: mcl_config_setup.h:43
mcl_common.h
Common module interface header file.
mcl_stream_data_read_callback_t
mcl_size_t(* mcl_stream_data_read_callback_t)(void *destination, void *source, mcl_size_t size, void *user_context)
Stream data read callback function definition.
Definition: mcl_stream_data.h:36
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_stream_data_t
struct mcl_stream_data_t mcl_stream_data_t
This struct is used for building the stream data type.
Definition: mcl_stream_data.h:41
mcl_size_t
size_t mcl_size_t
Definition: mcl_common.h:38