configuration.h
Go to the documentation of this file.
1 /*!**********************************************************************
2  *
3  * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
4  * All rights reserved.
5  *
6  *************************************************************************
7  *
8  * @file configuration.h
9  * @date Sep 8, 2016
10  * @brief Configuration module header file.
11  *
12  * This module contains type definition of configuration.
13  *
14  ************************************************************************/
15 
16 #ifndef CONFIGURATION_H_
17 #define CONFIGURATION_H_
18 
19 #include "string_type.h"
20 
24 typedef struct configuration_t
25 {
50 
51 #endif //CONFIGURATION_H_
string_t * proxy_domain
Proxy domain. Optional if proxy_hostname and proxy_username are not used.
Definition: configuration.h:34
E_MCL_PROXY
Proxy type definitions. Used inside of mcl_configuration_t.
Definition: mcl_common.h:64
mcl_uint32_t http_request_timeout
Timeout value (in seconds) for HTTP requests. Default timeout is 300 seconds.
Definition: configuration.h:37
string_t * proxy_password
Proxy password. Optional if proxy_hostname and proxy_username are not used.
Definition: configuration.h:33
E_MCL_SECURITY_PROFILE
Definitions of different security profiles for onboarding.
Definition: mcl_common.h:78
string_t * mindsphere_hostname
Mindsphere hostname.
Definition: configuration.h:26
string_t * exchange_endpoint
Uri for exchange endpoint.
Definition: configuration.h:42
string_t * tenant
Tenant name which is used in self issued JWT.
Definition: configuration.h:43
mcl_leave_critical_section_callback_t leave_critical_section
Custom function for leaving critical section (Optional, default is NULL).
Definition: configuration.h:48
E_MCL_PROXY proxy_type
Proxy type E_MCL_PROXY. Optional if proxy_hostname is not used.
Definition: configuration.h:31
mcl_load_registration_information_callback_t load_function
Custom function for loading registration information; if both load_function and save_function are non...
Definition: configuration.h:45
uint32_t mcl_uint32_t
Definition: mcl_common.h:45
uint16_t mcl_uint16_t
Definition: mcl_common.h:44
string_t * registration_endpoint
Uri for registration endpoint.
Definition: configuration.h:40
void(* mcl_leave_critical_section_callback_t)(void)
Callback function prototype to leave critical section (onboarding, key rotation, updating security in...
Definition: mcl_common.h:326
mcl_save_registration_information_callback_t save_function
Custom function for saving registration information; if both load_function and save_function are non-...
Definition: configuration.h:46
mcl_uint16_t proxy_port
Proxy port no. Optional if proxy_hostname is not used.
Definition: configuration.h:30
string_t * access_token_endpoint
Uri for access token endpoint.
Definition: configuration.h:41
E_MCL_SECURITY_PROFILE security_profile
Security levels E_MCL_SECURITY_PROFILE.
Definition: configuration.h:35
string_t * proxy_hostname
Proxy hostname. Optional.
Definition: configuration.h:29
mcl_uint16_t mindsphere_port
Mindsphere port no.
Definition: configuration.h:27
string_t * user_agent
User agent.
Definition: configuration.h:38
size_t mcl_size_t
Definition: mcl_common.h:38
mcl_size_t max_http_payload_size
Not valid for streamable request. Default value is 16K Bytes. Minimum value is 400 Bytes and maximum ...
Definition: configuration.h:36
String type module header file.
string_t * initial_access_token
Initial access token. Not used by the library if a registration access token is present in store_path...
Definition: configuration.h:39
string_t * store_path
Path of the file the library uses to save registration artifacts such as registration access token...
Definition: configuration.h:44
string_t * proxy_username
Proxy username. Optional if proxy_hostname is not used.
Definition: configuration.h:32
E_MCL_ERROR_CODE(* mcl_enter_critical_section_callback_t)(void)
Callback function prototype to enter critical section (onboarding, key rotation, updating security in...
Definition: mcl_common.h:319
mcl_enter_critical_section_callback_t enter_critical_section
Custom function for entering critical section (Optional, default is NULL).
Definition: configuration.h:47
string_t * mindsphere_certificate
Mindsphere certificate. Optional. If NULL, MCL will use default CA certificate store (if provided at ...
Definition: configuration.h:28