mcl_data_lake_object.h File Reference

Data Lake object interface header file. More...

#include "mcl_data_lake/mcl_data_lake_common.h"

Include dependency graph for mcl_data_lake_object.h:

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

Go to the source code of this file.

Typedefs
typedef mcl_size_t(*	mcl_data_lake_upload_callback) (char *buffer, mcl_size_t size, mcl_size_t count, void *user_context)
typedef struct mcl_data_lake_object_t	mcl_data_lake_object_t

Enumerations
enum	E_MCL_DATA_LAKE_OBJECT_PARAMETER {   MCL_DATA_LAKE_OBJECT_PARAMETER_PATH = 0, MCL_DATA_LAKE_OBJECT_PARAMETER_SIZE, MCL_DATA_LAKE_OBJECT_PARAMETER_UPLOAD_CALLBACK, MCL_DATA_LAKE_OBJECT_PARAMETER_USER_CONTEXT,   MCL_DATA_LAKE_OBJECT_PARAMETER_END }

Functions
MCL_DATA_LAKE_EXPORT mcl_error_t	mcl_data_lake_object_initialize (mcl_data_lake_object_t **object)
MCL_DATA_LAKE_EXPORT 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_DATA_LAKE_EXPORT void	mcl_data_lake_object_destroy (mcl_data_lake_object_t **object)

Detailed Description

Data Lake object interface header file.

This interface introduces data lake object structure.

Copyright

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

Definition in file mcl_data_lake_object.h.

Typedef Documentation

typedef struct mcl_data_lake_object_t mcl_data_lake_object_t

Handle for data lake object.

Definition at line 36 of file mcl_data_lake_object.h.

typedef mcl_size_t(* mcl_data_lake_upload_callback) (char *buffer, mcl_size_t size, mcl_size_t count, void *user_context)

Callback function prototype used by http client to copy object data to http request. The function will be called repeatedly until the function returns zero.

Parameters

[in]	buffer	Destination address for object.
[in]	size	Size, in bytes, of each element to be read.
[in]	count	Number of elements, each one with a size of size bytes.
[in]	user_context	Source address for object.

Returns

The total number of bytes successfully written.

Definition at line 31 of file mcl_data_lake_object.h.

Enumeration Type Documentation

enum E_MCL_DATA_LAKE_OBJECT_PARAMETER

Parameters for data lake object.

Enumerator
MCL_DATA_LAKE_OBJECT_PARAMETER_PATH	Remote path for data lake object as char*.
MCL_DATA_LAKE_OBJECT_PARAMETER_SIZE	Size of the data lake object in bytes as mcl_size_t*.
MCL_DATA_LAKE_OBJECT_PARAMETER_UPLOAD_CALLBACK	Callback as mcl_data_lake_upload_callback, which is used to upload data lake object.
MCL_DATA_LAKE_OBJECT_PARAMETER_USER_CONTEXT	Context as void* which will be passed to the callback.
MCL_DATA_LAKE_OBJECT_PARAMETER_END

Definition at line 41 of file mcl_data_lake_object.h.

Function Documentation

MCL_DATA_LAKE_EXPORT 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_DATA_LAKE_EXPORT 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_DATA_LAKE_EXPORT 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: