stream_data.h File Reference

Stream data module header file. More...

#include "mcl/mcl_stream_data.h"
#include "custom_data.h"
#include "data_types.h"

Include dependency graph for stream_data.h:

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

Go to the source code of this file.

Data Structures
struct	stream_data_t
	This struct is used for building the complete message of stream data. More...

Functions
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. More...
void	stream_data_destroy (stream_data_t **stream_data)
	Destroys stream_data. More...

Detailed Description

Stream data module header file.

---

Copyright

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

Date

Sep 26, 2016 Meta and payload parts of custom data type are initialized and filled in this file.

Definition in file stream_data.h.

Function Documentation

void stream_data_destroy

(

stream_data_t **

stream_data

)

Destroys stream_data.

Parameters

[in]

stream_data

Stream data handle to operate on.

Definition at line 57 of file stream_data.c.

References custom_data_destroy(), DEBUG_ENTRY, DEBUG_LEAVE, and MCL_FREE.

Referenced by _store_list_destroy_callback(), mcl_store_new_stream_data(), and stream_data_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Parameters

[in]	version	Meta version.
[in]	type	Meta type.
[in]	routing	Routing information in meta description of stream_data.
[in]	stream_data_read_callback	The callback function which will be used to fill the payload of this stream object while composing the http request.
[in]	user_context	This will be passed to the callback function in each call.
[out]	stream_data	Initialized stream data handle to operate on.

Returns

• MCL_OK in case of success.
• MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.

Definition at line 21 of file stream_data.c.

References ASSERT_CODE_MESSAGE, ASSERT_STATEMENT_CODE_MESSAGE, custom_data_initialize(), DEBUG_ENTRY, DEBUG_LEAVE, MCL_NEW, MCL_NULL, MCL_OK, MCL_OUT_OF_MEMORY, and stream_data_destroy().

Referenced by mcl_store_new_stream_data().

Here is the call graph for this function:

Here is the caller graph for this function: