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 stream_data.h
9 * @date Sep 26, 2016
10 * @brief Stream data module header file.
11 *
12 * Meta and payload parts of custom data type are initialized and filled in this file.
13 *
14 ************************************************************************/
15 
16 #ifndef STREAM_DATA_H_
17 #define STREAM_DATA_H_
18 
19 #include "mcl/mcl_stream_data.h"
20 #include "custom_data.h"
21 #include "data_types.h"
22 
26 typedef struct mcl_stream_data_t
27 {
28  custom_data_t *base;
29  void *user_context;
30  mcl_stream_data_read_callback_t read_callback;
31 } stream_data_t;
32 
48 E_MCL_ERROR_CODE stream_data_initialize(const char *version, const char *type, const char *routing, mcl_stream_data_read_callback_t stream_data_read_callback,
49  void *user_context, stream_data_t **stream_data);
50 
56 void stream_data_destroy(stream_data_t **stream_data);
57 
58 #endif //STREAM_DATA_H_
stream_data_destroy
void stream_data_destroy(stream_data_t **stream_data)
Destroys stream_data.
Definition: stream_data.c:57
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.h
Stream data module interface header file.
stream_data_initialize
E_MCL_ERROR_CODE stream_data_initialize(const char *version, const char *type, const char *routing, mcl_stream_data_read_callback_t stream_data_read_callback, void *user_context, stream_data_t **stream_data)
Initializes stream_data.
Definition: stream_data.c:21
stream_data_t::read_callback
mcl_stream_data_read_callback_t read_callback
Read callback of stream data.
Definition: stream_data.h:30
stream_data_t::base
custom_data_t * base
Type of base is custom data.
Definition: stream_data.h:28
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
stream_data_t::user_context
void * user_context
User context.
Definition: stream_data.h:29
custom_data_t
This struct is used for building the custom data type.
Definition: custom_data.h:24
stream_data_t
This struct is used for building the complete message of stream data.
Definition: stream_data.h:26
custom_data.h
Custom data module header file.
data_types.h
Data types module header file.