Core configuration module implementation file. More...

#include "mcl_core/mcl_core_configuration.h"
#include "core_configuration.h"
#include "definitions.h"
#include "mcl_core/mcl_string_util.h"
#include "mcl_core/mcl_assert.h"
#include "mcl_core/mcl_memory.h"
#include "string_util.h"

Include dependency graph for core_configuration.c:

Go to the source code of this file.

Macros
#define	USER_AGENT_HEADER_FORMAT "MCL/" MCL_VERSION_STRING " (%s)"

Functions
mcl_error_t	mcl_core_configuration_initialize (mcl_core_configuration_t **configuration)

mcl_error_t	mcl_core_configuration_set_parameter (mcl_core_configuration_t configuration, E_MCL_CORE_CONFIGURATION_PARAMETER parameter, const void value)

mcl_error_t	core_configuration_validate (core_configuration_t *configuration)

void	mcl_core_configuration_destroy (mcl_core_configuration_t **configuration)

void	core_configuration_log (core_configuration_t *configuration)

Detailed Description

Core configuration module implementation file.

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

Definition in file core_configuration.c.

Macro Definition Documentation

#define USER_AGENT_HEADER_FORMAT "MCL/" MCL_VERSION_STRING " (%s)"

Definition at line 17 of file core_configuration.c.

Referenced by mcl_core_configuration_set_parameter().

Function Documentation

void core_configuration_log ( core_configuration_t * configuration )

This function is used to log core configuration which is used to initialize core.

Parameters

[in] configuration Core configuration to log.

Definition at line 277 of file core_configuration.c.

Referenced by mcl_core_initialize().

Here is the caller graph for this function:

mcl_error_t core_configuration_validate ( core_configuration_t * configuration )

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

Parameters

[in] configuration Core configuration to validate.

Returns

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

Definition at line 196 of file core_configuration.c.

References MAXIMUM_HOST_NAME_LENGTH, MAXIMUM_PROXY_DOMAIN_LENGTH, MAXIMUM_PROXY_PASSWORD_LENGTH, MAXIMUM_PROXY_USER_NAME_LENGTH, MAXIMUM_USER_AGENT_LENGTH, MCL_ASSERT_CODE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_INVALID_PARAMETER, MCL_NULL, MCL_OK, core_configuration_t::mindsphere_hostname, core_configuration_t::proxy_domain, core_configuration_t::proxy_hostname, core_configuration_t::proxy_password, core_configuration_t::proxy_username, string_util_strnlen(), core_configuration_t::tenant, and core_configuration_t::user_agent.

Referenced by mcl_core_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

void mcl_core_configuration_destroy ( mcl_core_configuration_t ** configuration )

This function destroys the mcl_core_configuration_t data structure.

Parameters

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

Definition at line 253 of file core_configuration.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, MCL_NULL, and MCL_OK.

mcl_error_t mcl_core_configuration_initialize ( mcl_core_configuration_t ** configuration )

This function initializes a new mcl_core_configuration_t data structure with default values.

Parameters

[out] configuration Data structure holding the configuration parameters.

Returns

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

Definition at line 19 of file core_configuration.c.

References DEFAULT_HTTP_REQUEST_TIMEOUT, MCL_ASSERT_CODE_MESSAGE, MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_NEW, MCL_NULL, MCL_OK, MCL_OUT_OF_MEMORY, MCL_PROXY_UNKNOWN, and MCL_SECURITY_SHARED_SECRET.

mcl_error_t mcl_core_configuration_set_parameter	(	mcl_core_configuration_t *	configuration,
		E_MCL_CORE_CONFIGURATION_PARAMETER	parameter,
		const void *	value
	)

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

Parameters

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

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL if provided 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 57 of file core_configuration.c.

Here is the call graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

Function Documentation