mcl_configuration_t Struct Reference

#include <include/mcl/mcl_configuration.h>

Collaboration diagram for mcl_configuration_t:

Data Fields
char *	mindsphere_hostname
	Mindsphere hostname. More...
mcl_uint16_t	mindsphere_port
	Mindsphere port no. More...
char *	mindsphere_certificate
	Mindsphere certificate. Optional. If set to NULL, MCL will use default CA certificate store (if provided at build-time) for peer verification. More...
char *	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...
char *	proxy_username
	Proxy username. Optional if proxy_hostname is not used. More...
char *	proxy_password
	Proxy password. Optional if proxy_hostname and proxy_username are not used. More...
char *	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...
char *	user_agent
	User agent. More...
char *	initial_access_token
	Initial access token. Not used by the library if a registration access token is present in store_path. More...
char *	tenant
	Tenant name which is used in self issued JWT. More...
char *	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...

Detailed Description

This data structure holds the configuration parameters which are used to initialize mcl_communication_t data structure.

Warning

load_function and save_function are NULL by default.

Keeping any of these callback functions as NULL will result in registration information being saved to (and read from) the file (specified by store_path, if file system is available) with no encryption.

It is recommended to assign valid functions for both reading and saving registration information.

Definition at line 32 of file mcl_configuration.h.

Field Documentation

mcl_enter_critical_section_callback_t mcl_configuration_t::enter_critical_section

Custom function for entering critical section (Optional, default is NULL).

Definition at line 52 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

mcl_uint32_t mcl_configuration_t::http_request_timeout

Timeout value (in seconds) for HTTP requests. Default timeout is 300 seconds.

Definition at line 45 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_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 47 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

mcl_leave_critical_section_callback_t mcl_configuration_t::leave_critical_section

Custom function for leaving critical section (Optional, default is NULL).

Definition at line 53 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

mcl_load_registration_information_callback_t mcl_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 50 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

mcl_size_t mcl_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 44 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_configuration_t::mindsphere_certificate

Mindsphere certificate. Optional. If set to NULL, MCL will use default CA certificate store (if provided at build-time) for peer verification.

Definition at line 36 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_configuration_t::mindsphere_hostname

Mindsphere hostname.

Definition at line 34 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

mcl_uint16_t mcl_configuration_t::mindsphere_port

Mindsphere port no.

Definition at line 35 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_configuration_t::proxy_domain

Proxy domain. Optional if proxy_hostname and proxy_username are not used.

Definition at line 42 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_configuration_t::proxy_hostname

Proxy hostname. Optional.

Definition at line 37 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_configuration_t::proxy_password

Proxy password. Optional if proxy_hostname and proxy_username are not used.

Definition at line 41 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

mcl_uint16_t mcl_configuration_t::proxy_port

Proxy port no. Optional if proxy_hostname is not used.

Definition at line 38 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

E_MCL_PROXY mcl_configuration_t::proxy_type

Proxy type E_MCL_PROXY. Optional if proxy_hostname is not used.

Definition at line 39 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_configuration_t::proxy_username

Proxy username. Optional if proxy_hostname is not used.

Definition at line 40 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

mcl_save_registration_information_callback_t mcl_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 51 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

E_MCL_SECURITY_PROFILE mcl_configuration_t::security_profile

Security levels E_MCL_SECURITY_PROFILE.

Definition at line 43 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_configuration_t::store_path

Path of the file the library uses to save registration artifacts such as registration access token, etc.

Definition at line 49 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_configuration_t::tenant

Tenant name which is used in self issued JWT.

Definition at line 48 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

char* mcl_configuration_t::user_agent

User agent.

Definition at line 46 of file mcl_configuration.h.

Referenced by _log_configuration(), and mcl_communication_initialize().

---

The documentation for this struct was generated from the following file:

• include/mcl/mcl_configuration.h