mcl_configuration.h File Reference

Configuration module interface header file. More...

#include "mcl/mcl_common.h"

Include dependency graph for mcl_configuration.h:

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

Go to the source code of this file.

Data Structures
struct	mcl_configuration_t

Functions
MCL_EXPORT E_MCL_ERROR_CODE	mcl_configuration_initialize (mcl_configuration_t **configuration)
MCL_EXPORT mcl_configuration_t *	mcl_new_configuration ()
MCL_EXPORT E_MCL_ERROR_CODE	mcl_configuration_destroy (mcl_configuration_t **configuration)

Detailed Description

Configuration module interface header file.

---

Copyright

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

Date

Aug 3, 2016 This module is used for configuring MCL.

Definition in file mcl_configuration.h.

Function Documentation

MCL_EXPORT E_MCL_ERROR_CODE mcl_configuration_destroy

(

mcl_configuration_t **

configuration

)

This function destroys the mcl_configuration_t type object.

Parameters

[in]

configuration

Data structure holding the configuration parameters.

Returns

• MCL_OK in case of success.
• MCL_TRIGGERED_WITH_NULL in case configuration is NULL.

Definition at line 66 of file configuration.c.

References ASSERT_NOT_NULL, DEBUG_ENTRY, DEBUG_LEAVE, MCL_FREE, MCL_NULL, and MCL_OK.

MCL_EXPORT E_MCL_ERROR_CODE mcl_configuration_initialize

(

mcl_configuration_t **

configuration

)

This function initializes a new mcl_configuration_t data structure with default values and returns error code.

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 21 of file configuration.c.

References ASSERT_CODE_MESSAGE, ASSERT_NOT_NULL, DEBUG_ENTRY, DEBUG_LEAVE, DEFAULT_HTTP_PAYLOAD_SIZE, DEFAULT_HTTP_REQUEST_TIMEOUT, MCL_NEW, MCL_NULL, MCL_OK, MCL_OUT_OF_MEMORY, MCL_PROXY_UNKNOWN, and MCL_SECURITY_SHARED_SECRET.

Referenced by mcl_new_configuration().

Here is the caller graph for this function:

MCL_EXPORT mcl_configuration_t* mcl_new_configuration

(

)

This function creates a new mcl_configuration_t data structure with default values and returns a pointer to the new data structure.

Returns

Pointer to mcl_configuration_t data structure.

Definition at line 54 of file configuration.c.

References DEBUG_ENTRY, DEBUG_LEAVE, mcl_configuration_initialize(), and MCL_NULL.

Here is the call graph for this function: