mcl_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 mcl_configuration.h
9 * @date Aug 3, 2016
10 * @brief Configuration module interface header file.
11 *
12 * This module is used for configuring MCL.
13 *
14 ************************************************************************/
15 
16 #ifndef MCL_CONFIGURATION_H_
17 #define MCL_CONFIGURATION_H_
18 
19 #include "mcl/mcl_common.h"
20 
21 #ifdef __cplusplus
22 extern "C"
23 {
24 #endif
25 
32  typedef struct mcl_configuration_t
33  {
42  char *proxy_domain;
46  char *user_agent;
48  char *tenant;
49  char *store_path;
55 
68 
76 
88 
89 #ifdef __cplusplus
90 }
91 #endif
92 
93 #endif //MCL_CONFIGURATION_H_
E_MCL_SECURITY_PROFILE security_profile
Security levels E_MCL_SECURITY_PROFILE.
char * user_agent
User agent.
mcl_uint16_t proxy_port
Proxy port no. Optional if proxy_hostname is not used.
mcl_enter_critical_section_callback_t enter_critical_section
Custom function for entering critical section (Optional, default is NULL).
char * proxy_password
Proxy password. Optional if proxy_hostname and proxy_username are not used.
E_MCL_PROXY
Proxy type definitions. Used inside of mcl_configuration_t.
Definition: mcl_common.h:64
E_MCL_SECURITY_PROFILE
Definitions of different security profiles for onboarding.
Definition: mcl_common.h:78
#define MCL_EXPORT
MCL_EXPORT mcl_configuration_t * mcl_new_configuration()
Definition: configuration.c:54
char * tenant
Tenant name which is used in self issued JWT.
Common module interface header file.
mcl_load_registration_information_callback_t load_function
Custom function for loading registration information; if both load_function and save_function are non...
MCL_EXPORT E_MCL_ERROR_CODE mcl_configuration_initialize(mcl_configuration_t **configuration)
Definition: configuration.c:21
mcl_uint16_t mindsphere_port
Mindsphere port no.
E_MCL_ERROR_CODE
MCL Error code definitions. Every function returning an error code uses this enum values...
Definition: mcl_common.h:137
mcl_leave_critical_section_callback_t leave_critical_section
Custom function for leaving critical section (Optional, default is NULL).
uint32_t mcl_uint32_t
Definition: mcl_common.h:45
char * proxy_hostname
Proxy hostname. Optional.
uint16_t mcl_uint16_t
Definition: mcl_common.h:44
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
char * mindsphere_hostname
Mindsphere hostname.
mcl_uint32_t http_request_timeout
Timeout value (in seconds) for HTTP requests. Default timeout is 300 seconds.
char * proxy_username
Proxy username. Optional if proxy_hostname is not used.
E_MCL_PROXY proxy_type
Proxy type E_MCL_PROXY. Optional if proxy_hostname is not used.
mcl_save_registration_information_callback_t save_function
Custom function for saving registration information; if both load_function and save_function are non-...
size_t mcl_size_t
Definition: mcl_common.h:38
char * store_path
Path of the file the library uses to save registration artifacts such as registration access token...
char * proxy_domain
Proxy domain. Optional if proxy_hostname and proxy_username are not used.
char * initial_access_token
Initial access token. Not used by the library if a registration access token is present in store_path...
MCL_EXPORT E_MCL_ERROR_CODE mcl_configuration_destroy(mcl_configuration_t **configuration)
Definition: configuration.c:66
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_size_t max_http_payload_size
Not valid for streamable request. Default value is 16K Bytes. Minimum value is 400 Bytes and maximum ...
char * mindsphere_certificate
Mindsphere certificate. Optional. If set to NULL, MCL will use default CA certificate store (if provi...