#include <src/configuration.h>
Data Fields | |
| string_t * | mindsphere_hostname |
| Mindsphere hostname. More... | |
| mcl_uint16_t | mindsphere_port |
| Mindsphere port no. More... | |
| string_t * | mindsphere_certificate |
| Mindsphere certificate. Optional. If NULL, MCL will use default CA certificate store (if provided at build-time) for peer verification. More... | |
| string_t * | proxy_hostname |
| Proxy hostname. Optional. More... | |
| mcl_uint16_t | proxy_port |
| Proxy port no. Optional if proxy_hostname is not used. More... | |
| E_MCL_PROXY | proxy_type |
| Proxy type E_MCL_PROXY. Optional if proxy_hostname is not used. More... | |
| string_t * | proxy_username |
| Proxy username. Optional if proxy_hostname is not used. More... | |
| string_t * | proxy_password |
| Proxy password. Optional if proxy_hostname and proxy_username are not used. More... | |
| string_t * | proxy_domain |
| Proxy domain. Optional if proxy_hostname and proxy_username are not used. More... | |
| E_MCL_SECURITY_PROFILE | security_profile |
| Security levels E_MCL_SECURITY_PROFILE. More... | |
| mcl_size_t | max_http_payload_size |
| Not valid for streamable request. Default value is 16K Bytes. Minimum value is 400 Bytes and maximum value is the maximum value of mcl_size_t. More... | |
| mcl_uint32_t | http_request_timeout |
| Timeout value (in seconds) for HTTP requests. Default timeout is 300 seconds. More... | |
| string_t * | user_agent |
| User agent. More... | |
| string_t * | initial_access_token |
| Initial access token. Not used by the library if a registration access token is present in store_path. More... | |
| string_t * | registration_endpoint |
| Uri for registration endpoint. More... | |
| string_t * | access_token_endpoint |
| Uri for access token endpoint. More... | |
| string_t * | exchange_endpoint |
| Uri for exchange endpoint. More... | |
| string_t * | tenant |
| Tenant name which is used in self issued JWT. More... | |
| string_t * | store_path |
| Path of the file the library uses to save registration artifacts such as registration access token, etc. More... | |
| mcl_load_registration_information_callback_t | load_function |
| Custom function for loading registration information; if both load_function and save_function are non-null, custom functions will be used. More... | |
| mcl_save_registration_information_callback_t | save_function |
| Custom function for saving registration information; if both load_function and save_function are non-null, custom functions will be used. More... | |
| mcl_enter_critical_section_callback_t | enter_critical_section |
| Custom function for entering critical section (Optional, default is NULL). More... | |
| mcl_leave_critical_section_callback_t | leave_critical_section |
| Custom function for leaving critical section (Optional, default is NULL). More... | |
This data structure holds the configuration parameters after mcl_communication_t is initialized.
Definition at line 24 of file configuration.h.
| string_t* configuration_t::access_token_endpoint |
Uri for access token endpoint.
Definition at line 41 of file configuration.h.
Referenced by http_processor_get_access_token().
| mcl_enter_critical_section_callback_t configuration_t::enter_critical_section |
Custom function for entering critical section (Optional, default is NULL).
Definition at line 47 of file configuration.h.
| string_t* configuration_t::exchange_endpoint |
Uri for exchange endpoint.
Definition at line 42 of file configuration.h.
Referenced by http_processor_exchange(), and http_processor_stream().
| mcl_uint32_t configuration_t::http_request_timeout |
Timeout value (in seconds) for HTTP requests. Default timeout is 300 seconds.
Definition at line 37 of file configuration.h.
Referenced by http_client_initialize().
| string_t* configuration_t::initial_access_token |
Initial access token. Not used by the library if a registration access token is present in store_path.
Definition at line 39 of file configuration.h.
Referenced by http_processor_register().
| mcl_leave_critical_section_callback_t configuration_t::leave_critical_section |
Custom function for leaving critical section (Optional, default is NULL).
Definition at line 48 of file configuration.h.
| mcl_load_registration_information_callback_t configuration_t::load_function |
Custom function for loading registration information; if both load_function and save_function are non-null, custom functions will be used.
Definition at line 45 of file configuration.h.
Referenced by _custom_load_register_info(), _save_registration_information(), and http_processor_update_security_information().
| mcl_size_t configuration_t::max_http_payload_size |
Not valid for streamable request. Default value is 16K Bytes. Minimum value is 400 Bytes and maximum value is the maximum value of mcl_size_t.
Definition at line 36 of file configuration.h.
Referenced by http_processor_exchange(), http_processor_get_access_token(), http_processor_register(), and http_processor_stream().
| string_t* configuration_t::mindsphere_certificate |
Mindsphere certificate. Optional. If NULL, MCL will use default CA certificate store (if provided at build-time) for peer verification.
Definition at line 28 of file configuration.h.
Referenced by http_client_initialize().
| string_t* configuration_t::mindsphere_hostname |
Mindsphere hostname.
Definition at line 26 of file configuration.h.
Referenced by http_processor_get_access_token().
| mcl_uint16_t configuration_t::mindsphere_port |
Mindsphere port no.
Definition at line 27 of file configuration.h.
Referenced by http_client_initialize().
| string_t* configuration_t::proxy_domain |
Proxy domain. Optional if proxy_hostname and proxy_username are not used.
Definition at line 34 of file configuration.h.
Referenced by http_client_initialize().
| string_t* configuration_t::proxy_hostname |
Proxy hostname. Optional.
Definition at line 29 of file configuration.h.
Referenced by http_client_initialize().
| string_t* configuration_t::proxy_password |
Proxy password. Optional if proxy_hostname and proxy_username are not used.
Definition at line 33 of file configuration.h.
Referenced by http_client_initialize().
| mcl_uint16_t configuration_t::proxy_port |
Proxy port no. Optional if proxy_hostname is not used.
Definition at line 30 of file configuration.h.
Referenced by http_client_initialize().
| E_MCL_PROXY configuration_t::proxy_type |
Proxy type E_MCL_PROXY. Optional if proxy_hostname is not used.
Definition at line 31 of file configuration.h.
Referenced by http_client_initialize().
| string_t* configuration_t::proxy_username |
Proxy username. Optional if proxy_hostname is not used.
Definition at line 32 of file configuration.h.
Referenced by http_client_initialize().
| string_t* configuration_t::registration_endpoint |
Uri for registration endpoint.
Definition at line 40 of file configuration.h.
Referenced by http_processor_register().
| mcl_save_registration_information_callback_t configuration_t::save_function |
Custom function for saving registration information; if both load_function and save_function are non-null, custom functions will be used.
Definition at line 46 of file configuration.h.
Referenced by _save_registration_information(), and http_processor_update_security_information().
| E_MCL_SECURITY_PROFILE configuration_t::security_profile |
Security levels E_MCL_SECURITY_PROFILE.
Definition at line 35 of file configuration.h.
Referenced by _compose_access_token_request_payload(), _custom_load_register_info(), _save_registration_information(), http_processor_register(), and http_processor_update_security_information().
| string_t* configuration_t::store_path |
Path of the file the library uses to save registration artifacts such as registration access token, etc.
Definition at line 44 of file configuration.h.
Referenced by _save_registration_information(), and http_processor_update_security_information().
| string_t* configuration_t::tenant |
Tenant name which is used in self issued JWT.
Definition at line 43 of file configuration.h.
Referenced by _compose_access_token_request_payload().
| string_t* configuration_t::user_agent |
User agent.
Definition at line 38 of file configuration.h.
Referenced by http_processor_exchange(), http_processor_get_access_token(), http_processor_register(), and http_processor_stream().
1.8.11 
