time_series.h File Reference

Time series module header file. More...

#include "data_types.h"

Include dependency graph for time_series.h:

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

Go to the source code of this file.

Data Structures
struct	time_series_t
	This struct is used for building the complete message of time series event. More...

Functions
E_MCL_ERROR_CODE	time_series_initialize (const char *version, const char *configuration_id, const char *routing, time_series_t **time_series)
	This function creates and initializes a data struct of time_series_t. More...
void	time_series_destroy (time_series_t **time_series)
	To destroy the time_series_t data struct. More...

Detailed Description

Time series module header file.

---

Copyright

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

Date

Sep 26, 2016

Definition in file time_series.h.

Function Documentation

void time_series_destroy

(

time_series_t **

time_series

)

To destroy the time_series_t data struct.

Will release the time_series_t data struct. After destroy() operation, the data struct shouldn't be used.

Parameters

[out]

time_series

Stores all field members of time series json string.

Definition at line 123 of file time_series.c.

References _destroy_value_set(), DEBUG_ENTRY, DEBUG_LEAVE, list_destroy_with_content(), MCL_FREE, MCL_NULL, and string_destroy().

Referenced by _store_list_destroy_callback(), mcl_store_new_time_series(), and time_series_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

E_MCL_ERROR_CODE time_series_initialize	(	const char *	version,
		const char *	configuration_id,
		const char *	routing,
		time_series_t **	time_series
	)

This function creates and initializes a data struct of time_series_t.

Initialized meta fields: type, version, payload_type, payload_version and payload_details_configuration_id.

Parameters

[in]	version	Version number of time series event.
[in]	configuration_id	Unique identifier of the configuration.
[in]	routing	Routing information in meta description of time_series. This parameter is optional and can be NULL.
[out]	time_series	Pointer address of initialized time series data struct.

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 26 of file time_series.c.

References _initialize_meta(), ASSERT_CODE_MESSAGE, ASSERT_STATEMENT_CODE_MESSAGE, DEBUG_ENTRY, DEBUG_LEAVE, list_initialize(), MCL_NEW, MCL_NULL, MCL_OK, MCL_OUT_OF_MEMORY, and time_series_destroy().

Referenced by mcl_store_new_time_series().

Here is the call graph for this function:

Here is the caller graph for this function: