mcl_core_configuration.h
Go to the documentation of this file.
1 
11 #ifndef MCL_CORE_CONFIGURATION_H_
12 #define MCL_CORE_CONFIGURATION_H_
13 
14 #include "mcl_core/mcl_core_common.h"
15 
16 #ifdef __cplusplus
17 extern "C"
18 {
19 #endif
20 
24 typedef struct mcl_core_configuration_t mcl_core_configuration_t;
25 
29 typedef enum E_MCL_CORE_CONFIGURATION_PARAMETER
30 {
31  MCL_CORE_CONFIGURATION_PARAMETER_MDSP_HOST,
32  MCL_CORE_CONFIGURATION_PARAMETER_MDSP_PORT,
33  MCL_CORE_CONFIGURATION_PARAMETER_CERTIFICATE,
34  MCL_CORE_CONFIGURATION_PARAMETER_CERTIFICATE_FILE,
35  MCL_CORE_CONFIGURATION_PARAMETER_PROXY_TYPE,
36  MCL_CORE_CONFIGURATION_PARAMETER_PROXY_HOST,
37  MCL_CORE_CONFIGURATION_PARAMETER_PROXY_PORT,
38  MCL_CORE_CONFIGURATION_PARAMETER_PROXY_USER,
39  MCL_CORE_CONFIGURATION_PARAMETER_PROXY_PASS,
40  MCL_CORE_CONFIGURATION_PARAMETER_PROXY_DOMAIN,
41  MCL_CORE_CONFIGURATION_PARAMETER_SECURITY_PROFILE,
42  MCL_CORE_CONFIGURATION_PARAMETER_MAX_HTTP_PAYLOAD_SIZE,
43  MCL_CORE_CONFIGURATION_PARAMETER_HTTP_REQUEST_TIMEOUT,
44  MCL_CORE_CONFIGURATION_PARAMETER_USER_AGENT,
45  MCL_CORE_CONFIGURATION_PARAMETER_TENANT,
46  MCL_CORE_CONFIGURATION_PARAMETER_IAT,
47  MCL_CORE_CONFIGURATION_PARAMETER_CREDENTIALS_LOAD_CALLBACK,
48  MCL_CORE_CONFIGURATION_PARAMETER_CREDENTIALS_SAVE_CALLBACK,
49  MCL_CORE_CONFIGURATION_PARAMETER_CRITICAL_SECTION_ENTER_CALLBACK,
50  MCL_CORE_CONFIGURATION_PARAMETER_CRITICAL_SECTION_LEAVE_CALLBACK,
51  MCL_CORE_CONFIGURATION_PARAMETER_END
52 } E_MCL_CORE_CONFIGURATION_PARAMETER;
53 
65 extern MCL_CORE_EXPORT mcl_error_t mcl_core_configuration_initialize(mcl_core_configuration_t **configuration);
66 
81 extern MCL_CORE_EXPORT mcl_error_t mcl_core_configuration_set_parameter(mcl_core_configuration_t *configuration,
82  E_MCL_CORE_CONFIGURATION_PARAMETER parameter, const void *value);
83 
89 extern MCL_CORE_EXPORT void mcl_core_configuration_destroy(mcl_core_configuration_t **configuration);
90 
91 #ifdef __cplusplus
92 }
93 #endif
94 
95 #endif //MCL_CORE_CONFIGURATION_H_
MCL_CORE_CONFIGURATION_PARAMETER_END
Definition: mcl_core_configuration.h:51
MCL_CORE_CONFIGURATION_PARAMETER_MDSP_PORT
Mindsphere port parameter as mcl_uint16_t.
Definition: mcl_core_configuration.h:32
MCL_CORE_CONFIGURATION_PARAMETER_CRITICAL_SECTION_ENTER_CALLBACK
Custom function for entering critical section parameter as mcl_critical_section_enter_callback_t (opt...
Definition: mcl_core_configuration.h:49
MCL_CORE_CONFIGURATION_PARAMETER_CREDENTIALS_LOAD_CALLBACK
Custom function for loading credentials parameter as mcl_credentials_load_callback_t.
Definition: mcl_core_configuration.h:47
mcl_error_t
mcl_int32_t mcl_error_t
Definition: mcl_core_common.h:36
mcl_core_configuration_destroy
MCL_CORE_EXPORT void mcl_core_configuration_destroy(mcl_core_configuration_t **configuration)
Definition: core_configuration.c:253
MCL_CORE_CONFIGURATION_PARAMETER_PROXY_PORT
Proxy port number parameter as mcl_uint16_t. Mandatory if proxy host name is set, ineffective otherwi...
Definition: mcl_core_configuration.h:37
MCL_CORE_CONFIGURATION_PARAMETER_SECURITY_PROFILE
Security profile parameter as E_MCL_SECURITY_PROFILE.
Definition: mcl_core_configuration.h:41
MCL_CORE_CONFIGURATION_PARAMETER_CRITICAL_SECTION_LEAVE_CALLBACK
Custom function for leaving critical section parameter as mcl_critical_section_leave_callback_t (opti...
Definition: mcl_core_configuration.h:50
E_MCL_CORE_CONFIGURATION_PARAMETER
E_MCL_CORE_CONFIGURATION_PARAMETER
Definition: mcl_core_configuration.h:29
MCL_CORE_CONFIGURATION_PARAMETER_TENANT
Tenant parameter as char*.
Definition: mcl_core_configuration.h:45
mcl_core_configuration_t
struct mcl_core_configuration_t mcl_core_configuration_t
Definition: mcl_core_configuration.h:24
MCL_CORE_CONFIGURATION_PARAMETER_HTTP_REQUEST_TIMEOUT
HTTP request timeout (in seconds) parameter as mcl_uint32_t. Default timeout is 300 seconds...
Definition: mcl_core_configuration.h:43
MCL_CORE_CONFIGURATION_PARAMETER_IAT
Initial access token parameter as char*.
Definition: mcl_core_configuration.h:46
MCL_CORE_CONFIGURATION_PARAMETER_PROXY_HOST
Proxy host name parameter as char* (optional).
Definition: mcl_core_configuration.h:36
MCL_CORE_EXPORT
#define MCL_CORE_EXPORT
Definition: mcl_config_setup.h:38
MCL_CORE_CONFIGURATION_PARAMETER_PROXY_DOMAIN
Proxy domain parameter as char*. Optional if proxy host name and proxy username are set...
Definition: mcl_core_configuration.h:40
MCL_CORE_CONFIGURATION_PARAMETER_MAX_HTTP_PAYLOAD_SIZE
This is an obsolete parameter. Setting it will have no effect.
Definition: mcl_core_configuration.h:42
MCL_CORE_CONFIGURATION_PARAMETER_CREDENTIALS_SAVE_CALLBACK
Custom function for saving credentials parameter as mcl_credentials_save_callback_t.
Definition: mcl_core_configuration.h:48
mcl_core_configuration_initialize
MCL_CORE_EXPORT mcl_error_t mcl_core_configuration_initialize(mcl_core_configuration_t **configuration)
Definition: core_configuration.c:19
MCL_CORE_CONFIGURATION_PARAMETER_CERTIFICATE_FILE
Mindsphere certificate file parameter as char*. If certificate is not set (as itself or as file)...
Definition: mcl_core_configuration.h:34
MCL_CORE_CONFIGURATION_PARAMETER_PROXY_PASS
Proxy password parameter as char*. Mandatory if proxy host name and proxy username are set...
Definition: mcl_core_configuration.h:39
MCL_CORE_CONFIGURATION_PARAMETER_MDSP_HOST
Mindsphere hostname parameter as char*.
Definition: mcl_core_configuration.h:31
MCL_CORE_CONFIGURATION_PARAMETER_USER_AGENT
User agent parameter as char*.
Definition: mcl_core_configuration.h:44
MCL_CORE_CONFIGURATION_PARAMETER_CERTIFICATE
Mindsphere certificate parameter as char*. If certificate is not set (as itself or as file)...
Definition: mcl_core_configuration.h:33
MCL_CORE_CONFIGURATION_PARAMETER_PROXY_TYPE
Proxy type parameter as E_MCL_PROXY. Mandatory if proxy host name is set, ineffective otherwise...
Definition: mcl_core_configuration.h:35
mcl_core_configuration_set_parameter
MCL_CORE_EXPORT mcl_error_t mcl_core_configuration_set_parameter(mcl_core_configuration_t *configuration, E_MCL_CORE_CONFIGURATION_PARAMETER parameter, const void *value)
Definition: core_configuration.c:57
mcl_core_common.h
Common module interface header file.
MCL_CORE_CONFIGURATION_PARAMETER_PROXY_USER
Proxy username parameter as char*. Optional if proxy host name is set, ineffective otherwise...
Definition: mcl_core_configuration.h:38