mcl_connectivity_configuration.h File Reference

Connectivity configuration module header file. More...

#include "mcl_connectivity/mcl_connectivity_common.h"

Include dependency graph for mcl_connectivity_configuration.h:

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

Go to the source code of this file.

Macros
#define	MCL_CONNECTIVITY_MAX_HTTP_PAYLOAD_SIZE   (10485760)
#define	MCL_CONNECTIVITY_DEFAULT_MAX_HTTP_PAYLOAD_SIZE   (16384)
#define	MCL_CONNECTIVITY_MIN_HTTP_PAYLOAD_SIZE   (400)

Typedefs
typedef struct mcl_connectivity_configuration_t	mcl_connectivity_configuration_t

Enumerations
enum	E_MCL_CONNECTIVITY_CONFIGURATION_PARAMETER { MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_CORE = 0, MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_MAX_HTTP_PAYLOAD_SIZE, MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_END }

Functions
MCL_CONNECTIVITY_EXPORT mcl_error_t	mcl_connectivity_configuration_initialize (mcl_connectivity_configuration_t **configuration)
MCL_CONNECTIVITY_EXPORT mcl_error_t	mcl_connectivity_configuration_set_parameter (mcl_connectivity_configuration_t *configuration, E_MCL_CONNECTIVITY_CONFIGURATION_PARAMETER parameter, const void *value)
MCL_CONNECTIVITY_EXPORT void	mcl_connectivity_configuration_destroy (mcl_connectivity_configuration_t **configuration)

Detailed Description

Connectivity configuration module header file.

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

Copyright

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

Definition in file mcl_connectivity_configuration.h.

Macro Definition Documentation

#define MCL_CONNECTIVITY_DEFAULT_MAX_HTTP_PAYLOAD_SIZE   (16384)

16K is default value for maximum HTTP payload size for connectivity module, although server can handle up to MCL_CONNECTIVITY_MAX_HTTP_PAYLOAD_SIZE.

Definition at line 31 of file mcl_connectivity_configuration.h.

Referenced by mcl_connectivity_configuration_initialize().

#define MCL_CONNECTIVITY_MAX_HTTP_PAYLOAD_SIZE   (10485760)

Http request payload size limit for MindSphere Connectivity.

Definition at line 25 of file mcl_connectivity_configuration.h.

Referenced by mcl_connectivity_configuration_set_parameter().

#define MCL_CONNECTIVITY_MIN_HTTP_PAYLOAD_SIZE   (400)

This is the minimum value which you can set MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_MAX_HTTP_PAYLOAD_SIZE to.

Definition at line 36 of file mcl_connectivity_configuration.h.

Referenced by mcl_connectivity_configuration_set_parameter().

Typedef Documentation

typedef struct mcl_connectivity_configuration_t mcl_connectivity_configuration_t

Definition at line 38 of file mcl_connectivity_configuration.h.

Enumeration Type Documentation

enum E_MCL_CONNECTIVITY_CONFIGURATION_PARAMETER

Parameters for connectivity configuration.

Enumerator
MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_CORE	Core parameter as mcl_core_t *.
MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_MAX_HTTP_PAYLOAD_SIZE	Max HTTP payload size parameter as mcl_size_t *.
MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_END

Definition at line 43 of file mcl_connectivity_configuration.h.

Function Documentation

MCL_CONNECTIVITY_EXPORT 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_CONNECTIVITY_EXPORT 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_CONNECTIVITY_EXPORT 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.

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 connectivity_configuration.c.

References _set_connectivity_configuration_core_parameter(), MCL_ASSERT_NOT_NULL, MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_CORE, MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_MAX_HTTP_PAYLOAD_SIZE, MCL_CONNECTIVITY_MAX_HTTP_PAYLOAD_SIZE, MCL_CONNECTIVITY_MIN_HTTP_PAYLOAD_SIZE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_INVALID_PARAMETER, and MCL_OK.

Here is the call graph for this function: