Data lake object module implementation file. More...

#include "data_lake_object.h"
#include "mcl_core/mcl_memory.h"
#include "mcl_core/mcl_string_util.h"

Include dependency graph for data_lake_object.c:

Functions
mcl_error_t	mcl_data_lake_object_initialize (mcl_data_lake_object_t **object)

mcl_error_t	mcl_data_lake_object_set_parameter (mcl_data_lake_object_t object, E_MCL_DATA_LAKE_OBJECT_PARAMETER parameter, const void value)

mcl_error_t	data_lake_object_set_internal_parameter (mcl_data_lake_object_t object, E_DATA_LAKE_OBJECT_INTERNAL_PARAMETER parameter, const void value)

void	mcl_data_lake_object_destroy (mcl_data_lake_object_t **object)

mcl_error_t	data_lake_object_validate (data_lake_object_t *object)

Detailed Description

Data lake object module implementation file.

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

Definition in file data_lake_object.c.

Function Documentation

mcl_error_t data_lake_object_set_internal_parameter	(	mcl_data_lake_object_t *	object,
		E_DATA_LAKE_OBJECT_INTERNAL_PARAMETER	parameter,
		const void *	value
	)

This function is used to set an internal parameter of a data lake object.

Parameters

[in]	object	Data lake object to set its parameter.
[in]	parameter	One of the parameters listed in E_DATA_LAKE_OBJECT_INTERNAL_PARAMETER.
[in]	value	New value of the `parameter`.

Returns

MCL_OK in case of success.
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 82 of file data_lake_object.c.

References DATA_LAKE_OBJECT_INTERNAL_PARAMETER_SIGNED_URL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_INVALID_PARAMETER, MCL_OK, and mcl_string_util_reset().

Here is the call graph for this function:

mcl_error_t data_lake_object_validate ( data_lake_object_t * object )

This function checks whether all mandatory parameters of a data lake object are set or not.

Parameters

[in] object Data lake object to validate.

Returns

MCL_OK in case of success.
MCL_INVALID_PARAMETER in case data lake object has one or more missing mandatory parameters.

Definition at line 116 of file data_lake_object.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_ERROR_STRING, MCL_INVALID_PARAMETER, MCL_NULL, MCL_OK, data_lake_object_t::path, data_lake_object_t::signed_url, data_lake_object_t::size, and data_lake_object_t::upload_callback.

Referenced by data_lake_processor_upload().

Here is the caller graph for this function:

void mcl_data_lake_object_destroy ( mcl_data_lake_object_t ** object )

This function destroys data lake object structure.

Parameters

[in] object Object to be destroyed.

Definition at line 102 of file data_lake_object.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, and MCL_NULL.

mcl_error_t mcl_data_lake_object_initialize ( mcl_data_lake_object_t ** object )

This function creates and initializes a data struct of mcl_data_lake_object_t.

Parameters

[out] object Object to initialize.

Returns

MCL_OK in case of success.
MCL_OUT_OF_MEMORY if memory allocation fails.
MCL_TRIGGERED_WITH_NULL in case input parameter is NULL.

Definition at line 13 of file data_lake_object.c.

References MCL_ASSERT_NOT_NULL, 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_data_lake_object_set_parameter	(	mcl_data_lake_object_t *	object,
		E_MCL_DATA_LAKE_OBJECT_PARAMETER	parameter,
		const void *	value
	)

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

Parameters

[in]	object	Data lake object to set its parameter.
[in]	parameter	One of the parameters listed in E_MCL_DATA_LAKE_OBJECT_PARAMETER.
[in]	value	New value of the `parameter`.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL if provided object 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 44 of file data_lake_object.c.

References MCL_ASSERT_NOT_NULL, MCL_DATA_LAKE_OBJECT_PARAMETER_PATH, MCL_DATA_LAKE_OBJECT_PARAMETER_SIZE, MCL_DATA_LAKE_OBJECT_PARAMETER_UPLOAD_CALLBACK, MCL_DATA_LAKE_OBJECT_PARAMETER_USER_CONTEXT, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_INVALID_PARAMETER, MCL_OK, and mcl_string_util_reset().

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation