Connectivity configuration module implementation file. More...

#include "mcl_connectivity/mcl_connectivity_configuration.h"
#include "connectivity_configuration.h"
#include "mcl_core/mcl_memory.h"
#include "mcl_core/mcl_string_util.h"

Include dependency graph for connectivity_configuration.c:

Go to the source code of this file.

Functions
static mcl_error_t	_set_connectivity_configuration_core_parameter (mcl_connectivity_configuration_t configuration, mcl_core_t core)

mcl_error_t	mcl_connectivity_configuration_initialize (mcl_connectivity_configuration_t **configuration)

mcl_error_t	mcl_connectivity_configuration_set_parameter (mcl_connectivity_configuration_t configuration, E_MCL_CONNECTIVITY_CONFIGURATION_PARAMETER parameter, const void value)

void	mcl_connectivity_configuration_destroy (mcl_connectivity_configuration_t **configuration)

mcl_error_t	connectivity_configuration_validate (connectivity_configuration_t *configuration)

Variables
static const char	_connectivity_exchange_uri [] = "/api/mindconnect/v3/exchange"

static const char	_connectivity_mapping_url [] = "/api/mindconnect/v3/dataPointMappings"

Detailed Description

Connectivity configuration module implementation file.

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

Definition in file connectivity_configuration.c.

Function Documentation

static mcl_error_t _set_connectivity_configuration_core_parameter	(	mcl_connectivity_configuration_t *	configuration,
		mcl_core_t *	core
	)

static

Definition at line 119 of file connectivity_configuration.c.

References _connectivity_exchange_uri, _connectivity_mapping_url, mcl_core_get_host_name(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, MCL_INVALID_PARAMETER, MCL_NULL, MCL_OK, and mcl_string_util_concatenate().

Referenced by mcl_connectivity_configuration_set_parameter().

Here is the call graph for this function:

Here is the caller graph for this function:

mcl_error_t connectivity_configuration_validate ( connectivity_configuration_t * configuration )

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

Parameters

[in] configuration Connectivity configuration to validate.

Returns

MCL_OK in case of success.
MCL_INVALID_PARAMETER in case Connectivity configuration has one or more missing mandatory parameter.

Definition at line 104 of file connectivity_configuration.c.

References connectivity_configuration_t::core, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_INVALID_PARAMETER, MCL_NULL, and MCL_OK.

Referenced by mcl_connectivity_initialize().

Here is the caller graph for this function:

void mcl_connectivity_configuration_destroy ( mcl_connectivity_configuration_t ** configuration )

This function destroys mcl_connectivity_configuration_t data structure.

Parameters

[in] configuration Connectivity configuration handle which is going to be destroyed.

Definition at line 90 of file connectivity_configuration.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, and MCL_NULL.

mcl_error_t mcl_connectivity_configuration_initialize ( mcl_connectivity_configuration_t ** configuration )

Definition at line 21 of file connectivity_configuration.c.

References MCL_ASSERT_NOT_NULL, MCL_CONNECTIVITY_DEFAULT_MAX_HTTP_PAYLOAD_SIZE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_NEW, MCL_NULL, MCL_OK, and MCL_OUT_OF_MEMORY.

mcl_error_t mcl_connectivity_configuration_set_parameter	(	mcl_connectivity_configuration_t *	configuration,
		E_MCL_CONNECTIVITY_CONFIGURATION_PARAMETER	parameter,
		const void *	value
	)

This function is used to set a parameter of a connectivity configuration.

Parameters

[in]	configuration	Connectivity configuration to set its parameter.
[in]	parameter	One of the parameters listed in E_MCL_CONNECTIVITY_CONFIGURATION_PARAMETER.
[in]	value	New value of the `parameter`.