custom_data.h File Reference

Custom data module header file. More...

#include "data_types.h"

Include dependency graph for custom_data.h:

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

Go to the source code of this file.

Data Structures
struct	custom_data_t
	This struct is used for building the custom data type. More...

Functions
E_MCL_ERROR_CODE	custom_data_initialize (const char *version, const char *type, const char *routing, custom_data_t **custom_data)
	Initializes custom_data. More...
void	custom_data_destroy (custom_data_t **custom_data)
	Destroys custom_data. More...

Detailed Description

Custom 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 set by this module.

Definition in file custom_data.h.

Function Documentation

void custom_data_destroy

(

custom_data_t **

custom_data

)

Destroys custom_data.

Parameters

[in]

custom_data

All meta and payload details, content etc. stored in this data struct.

Definition at line 72 of file custom_data.c.

References DEBUG_ENTRY, DEBUG_LEAVE, json_util_destroy(), MCL_FREE, MCL_NULL, and string_destroy().

Referenced by _store_list_destroy_callback(), custom_data_initialize(), mcl_store_new_custom_data(), and stream_data_destroy().

Here is the call graph for this function:

Here is the caller graph for this function:

E_MCL_ERROR_CODE custom_data_initialize	(	const char *	version,
		const char *	type,
		const char *	routing,
		custom_data_t **	custom_data
	)

Initializes custom_data.

Parameters

[in]	version	Meta version.
[in]	type	Meta type.
[in]	routing	Routing information in meta description of custom_data. This parameter is optional and can be NULL.
[out]	custom_data	Custom 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 24 of file custom_data.c.

References _initialize_custom_data_meta_fields(), ASSERT_CODE_MESSAGE, ASSERT_STATEMENT_CODE_MESSAGE, custom_data_destroy(), DEBUG_ENTRY, DEBUG_LEAVE, MCL_NEW, MCL_NULL, MCL_OK, and MCL_OUT_OF_MEMORY.

Referenced by mcl_store_new_custom_data(), and stream_data_initialize().

Here is the call graph for this function:

Here is the caller graph for this function: