mcl_stream_data.h File Reference

Stream data module interface header file. More...

#include "mcl_common.h"

Include dependency graph for mcl_stream_data.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct mcl_json_t	mcl_json_t
	This struct is used for json handling. More...
typedef 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. More...
typedef struct mcl_stream_data_t	mcl_stream_data_t
	This struct is used for building the stream data type. More...

Functions
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. More...

Detailed Description

Stream data module interface header file.

---

Copyright

Copyright (C) 2016 Siemens Aktiengesellschaft.
All rights reserved.

Date

Dec 26, 2016

Definition in file mcl_stream_data.h.

Typedef Documentation

typedef struct mcl_json_t mcl_json_t

This struct is used for json handling.

Definition at line 27 of file mcl_stream_data.h.

typedef 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.

source parameter has been added in order to accommodate the general callback format. It will be NULL. Should return the amount of actually written bytes. Return 0 if there is no more data to write.

Definition at line 36 of file mcl_stream_data.h.

typedef struct mcl_stream_data_t mcl_stream_data_t

This struct is used for building the stream data type.

Definition at line 41 of file mcl_stream_data.h.

Function Documentation

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.

Parameters

[in]	stream_data	All meta and payload details, callback etc. stored in this data struct.
[in]	details	A custom json object to form meta details.

Returns

• MCL_OK in case of success.
• MCL_TRIGGERED_WITH_NULL if provided stream_data or details is NULL.
• MCL_OUT_OF_MEMORY if any memory allocation fails.

Definition at line 43 of file stream_data.c.

References ASSERT_NOT_NULL, DEBUG_ENTRY, DEBUG_LEAVE, and mcl_custom_data_set_meta_details().

Here is the call graph for this function: