mcl_data_lake_configuration.h File Reference

Data lake configuration module header file. More...

#include "mcl_data_lake/mcl_data_lake_common.h"

Include dependency graph for mcl_data_lake_configuration.h:

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

Go to the source code of this file.

Typedefs
typedef struct mcl_data_lake_configuration_t	mcl_data_lake_configuration_t

Enumerations
enum	E_MCL_DATA_LAKE_CONFIGURATION_PARAMETER { MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CORE = 0, MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CERTIFICATE, MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CERTIFICATE_FILE, MCL_DATA_LAKE_CONFIGURATION_PARAMETER_END }

Functions
MCL_DATA_LAKE_EXPORT mcl_error_t	mcl_data_lake_configuration_initialize (mcl_data_lake_configuration_t **configuration)
MCL_DATA_LAKE_EXPORT mcl_error_t	mcl_data_lake_configuration_set_parameter (mcl_data_lake_configuration_t *configuration, E_MCL_DATA_LAKE_CONFIGURATION_PARAMETER parameter, const void *value)
MCL_DATA_LAKE_EXPORT void	mcl_data_lake_configuration_destroy (mcl_data_lake_configuration_t **configuration)

Detailed Description

Data lake configuration module header file.

This interface introduces configuration data structure for #mcl_data_lake module and functions to initialize and set parameters of this configuration.

Copyright

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

Definition in file mcl_data_lake_configuration.h.

Typedef Documentation

typedef struct mcl_data_lake_configuration_t mcl_data_lake_configuration_t

Handle for data lake configuration.

Definition at line 25 of file mcl_data_lake_configuration.h.

Enumeration Type Documentation

enum E_MCL_DATA_LAKE_CONFIGURATION_PARAMETER

Parameters for data lake configuration.

Enumerator
MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CORE	Core parameter as mcl_core_t *.
MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CERTIFICATE	Certificate parameter as char* for the server of the pre-signed url (e.g. AWS certificate if the pre-signed url belongs to AWS.). If certificate is not set (as itself or as file), default CA certificate store will be used (if available).
MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CERTIFICATE_FILE	Certificate file parameter as char* for the server of the pre-signed url (e.g. AWS certificate if the pre-signed url belongs to AWS.). If certificate is not set (as itself or as file), default CA certificate store will be used (if available).
MCL_DATA_LAKE_CONFIGURATION_PARAMETER_END

Definition at line 30 of file mcl_data_lake_configuration.h.

Function Documentation

MCL_DATA_LAKE_EXPORT void mcl_data_lake_configuration_destroy

(

mcl_data_lake_configuration_t **

configuration

)

This function destroys mcl_data_lake_configuration_t data structure.

Parameters

[in]

configuration

Data lake configuration handle which is going to be destroyed.

Definition at line 107 of file data_lake_configuration.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, and MCL_NULL.

MCL_DATA_LAKE_EXPORT mcl_error_t mcl_data_lake_configuration_initialize

(

mcl_data_lake_configuration_t **

configuration

)

This function creates and initializes a data struct of mcl_data_lake_configuration_t.

Parameters

[out]

configuration

Data structure holding the data lake configuration parameters.

Returns

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

Definition at line 20 of file data_lake_configuration.c.

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

MCL_DATA_LAKE_EXPORT mcl_error_t mcl_data_lake_configuration_set_parameter	(	mcl_data_lake_configuration_t *	configuration,
		E_MCL_DATA_LAKE_CONFIGURATION_PARAMETER	parameter,
		const void *	value
	)

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

Parameters

[in]	configuration	Data lake configuration to set its parameter.
[in]	parameter	One of the parameters listed in E_MCL_DATA_LAKE_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_INVALID_PARAMETER if provided parameter is invalid.
• MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.

Definition at line 50 of file data_lake_configuration.c.

References _set_data_lake_configuration_core_parameter(), MCL_ASSERT_NOT_NULL, MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CERTIFICATE, MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CERTIFICATE_FILE, MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CORE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FALSE, MCL_FUNCTION_LEAVE_LABEL, MCL_INVALID_PARAMETER, MCL_NO_FILE_SUPPORT, MCL_OK, mcl_string_util_reset(), and MCL_TRUE.

Here is the call graph for this function: