Data source configuration module implementation file. More...

#include "mcl_connectivity/mcl_data_source_configuration.h"
#include "data_source_configuration.h"
#include "mcl_core/mcl_memory.h"
#include "mcl_core/mcl_string_util.h"

Include dependency graph for data_source_configuration.c:

Go to the source code of this file.

Functions
mcl_error_t	mcl_data_source_configuration_initialize (E_MCL_DATA_SOURCE_CONFIGURATION_VERSION version, mcl_data_source_configuration_t **data_source_configuration)

mcl_error_t	mcl_data_source_configuration_set_parameter (mcl_data_source_configuration_t data_source_configuration, E_MCL_DATA_SOURCE_CONFIGURATION_PARAMETER parameter, const void value)

mcl_error_t	mcl_data_source_configuration_add_data_source (mcl_data_source_configuration_t data_source_configuration, mcl_data_source_t data_source)

mcl_error_t	data_source_configuration_validate (data_source_configuration_t *data_source_configuration)

void	mcl_data_source_configuration_destroy (mcl_data_source_configuration_t **data_source_configuration)

Variables
const char *	mcl_data_source_configuration_versions [MCL_DATA_SOURCE_CONFIGURATION_END] = { "1.0" }

Detailed Description

Data source configuration module implementation file.

Copyright: Copyright (C) 2019 Siemens Aktiengesellschaft.
All rights reserved.

Definition in file data_source_configuration.c.

Function Documentation

mcl_error_t data_source_configuration_validate ( data_source_configuration_t * data_source_configuration )

This function checks whether all mandatory parameters of a data source configuration are set or not.

Parameters

[in] data_source_configuration Data source configuration to validate.

Returns

MCL_OK in case of success.
MCL_INVALID_PARAMETER in case data source configuration has one or more missing mandatory parameters.

Definition at line 113 of file data_source_configuration.c.

References data_source_configuration_payload_t::configuration_id, mcl_list_t::count, mcl_list_node_t::data, data_source_validate(), data_source_configuration_payload_t::data_sources, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_ERROR_STRING, MCL_INVALID_PARAMETER, mcl_list_next(), mcl_list_reset(), MCL_NULL, MCL_OK, and data_source_configuration_t::payload.

Referenced by _store_add_data(), and connectivity_processor_exchange().

Here is the call graph for this function:

Here is the caller graph for this function:

mcl_error_t mcl_data_source_configuration_add_data_source	(	mcl_data_source_configuration_t *	data_source_configuration,
		mcl_data_source_t *	data_source
	)

This function adds data_source to data_source_configuration.

Parameters

[in]	data_source_configuration	mcl_data_source_configuration_t object handle which `data_source` is added to.
[in]	data_source	mcl_data_source_t object handle which contains data source information.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL in case data_source_configuration or data_source is null.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
MCL_LIMIT_EXCEEDED in case data_source_configuration has no space for a new data source.

Definition at line 94 of file data_source_configuration.c.

References MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, and mcl_list_add().

Here is the call graph for this function:

void mcl_data_source_configuration_destroy ( mcl_data_source_configuration_t ** data_source_configuration )

This function destroys data_source_configuration.

Parameters

[in] data_source_configuration mcl_data_source_configuration_t object handle that will be destroyed.

Definition at line 155 of file data_source_configuration.c.

References mcl_data_source_destroy(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, mcl_list_destroy_with_content(), and MCL_NULL.

Referenced by _item_destroy(), _parse_data_source_configuration(), and mcl_data_source_configuration_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

mcl_error_t mcl_data_source_configuration_initialize	(	E_MCL_DATA_SOURCE_CONFIGURATION_VERSION	version,
		mcl_data_source_configuration_t **	data_source_configuration
	)

This function initializes data_source_configuration.

Parameters

[in]	version	Version of the data source configuration.
[out]	data_source_configuration	Initialized mcl_data_source_configuration_t object handle.

Returns

MCL_OK in case of success.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
MCL_TRIGGERED_WITH_NULL in case data_source_configuration is null.
MCL_INVALID_PARAMETER in case version is invalid.

Definition at line 17 of file data_source_configuration.c.

References MCL_ASSERT_CODE_MESSAGE, MCL_ASSERT_NOT_NULL, mcl_data_source_configuration_destroy(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_INVALID_PARAMETER, MCL_ITEM_PREAMBLE, MCL_ITEM_TYPE_DATA_SOURCE_CONFIGURATION, mcl_list_initialize(), MCL_NEW, MCL_NULL, MCL_OK, and MCL_OUT_OF_MEMORY.

Referenced by _parse_data_source_configuration().

Here is the call graph for this function:

Here is the caller graph for this function:

mcl_error_t mcl_data_source_configuration_set_parameter	(	mcl_data_source_configuration_t *	data_source_configuration,
		E_MCL_DATA_SOURCE_CONFIGURATION_PARAMETER	parameter,
		const void *	value
	)

This function is used to set a parameter of a data source configuration.

Parameters

[in]	data_source_configuration	Data source configuration to set its parameter.
[in]	parameter	One of the parameters listed in E_MCL_DATA_SOURCE_CONFIGURATION_PARAMETER.
[in]	value	New value of the `parameter`.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL if provided data_source_configuration or value is NULL.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
MCL_INVALID_PARAMETER if provided parameter is invalid.

Definition at line 68 of file data_source_configuration.c.

References MCL_ASSERT_NOT_NULL, MCL_DATA_SOURCE_CONFIGURATION_PARAMETER_ID, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_INVALID_PARAMETER, and mcl_string_util_reset().

Here is the call graph for this function:

Variable Documentation

const char* mcl_data_source_configuration_versions[MCL_DATA_SOURCE_CONFIGURATION_END] = { "1.0" }

This array is used to get the data source configuration version.

Definition at line 15 of file data_source_configuration.c.

Referenced by _add_item_meta_payload(), and _item_meta_size().

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation