mcl_http_client_configuration_t Struct Reference

#include <mcl_core/include/mcl_core/mcl_http_client.h>

Collaboration diagram for mcl_http_client_configuration_t:
Collaboration graph

Data Fields

const char * certificate
 Certificate. If it is NULL, default CA certificate store will be used (if available). More...
 
mcl_bool_t certificate_is_file
 Flag to check if certificate is given as file or string. More...
 
const char * proxy_hostname
 Proxy hostname. Optional. More...
 
const char * proxy_username
 Proxy username. Optional if proxy host name is set, ineffective otherwise. More...
 
const char * proxy_password
 Proxy password. Mandatory if proxy host name and proxy username are set, ineffective otherwise. More...
 
const char * proxy_domain
 Proxy domain. Optional if proxy host name and proxy username are set, ineffective otherwise. More...
 
const char * user_agent
 User agent. More...
 
mcl_uint32_t http_request_timeout
 Timeout value (in seconds) for HTTP requests. Default timeout is 300 seconds. More...
 
mcl_uint16_t port
 Port number. More...
 
mcl_uint16_t proxy_port
 Proxy port number. Mandatory if proxy host name is set, ineffective otherwise. More...
 
E_MCL_PROXY proxy_type
 Proxy type E_MCL_PROXY. Mandatory if proxy host name is set, ineffective otherwise. More...
 

Detailed Description

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

Definition at line 37 of file mcl_http_client.h.

Field Documentation

const char* mcl_http_client_configuration_t::certificate

Certificate. If it is NULL, default CA certificate store will be used (if available).

Definition at line 39 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

mcl_bool_t mcl_http_client_configuration_t::certificate_is_file

Flag to check if certificate is given as file or string.

Definition at line 40 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

mcl_uint32_t mcl_http_client_configuration_t::http_request_timeout

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

Definition at line 46 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

mcl_uint16_t mcl_http_client_configuration_t::port

Port number.

Definition at line 47 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

const char* mcl_http_client_configuration_t::proxy_domain

Proxy domain. Optional if proxy host name and proxy username are set, ineffective otherwise.

Definition at line 44 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

const char* mcl_http_client_configuration_t::proxy_hostname

Proxy hostname. Optional.

Definition at line 41 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

const char* mcl_http_client_configuration_t::proxy_password

Proxy password. Mandatory if proxy host name and proxy username are set, ineffective otherwise.

Definition at line 43 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

mcl_uint16_t mcl_http_client_configuration_t::proxy_port

Proxy port number. Mandatory if proxy host name is set, ineffective otherwise.

Definition at line 48 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

E_MCL_PROXY mcl_http_client_configuration_t::proxy_type

Proxy type E_MCL_PROXY. Mandatory if proxy host name is set, ineffective otherwise.

Definition at line 49 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

const char* mcl_http_client_configuration_t::proxy_username

Proxy username. Optional if proxy host name is set, ineffective otherwise.

Definition at line 42 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().

const char* mcl_http_client_configuration_t::user_agent

User agent.

Definition at line 45 of file mcl_http_client.h.

Referenced by core_processor_initialize(), and mcl_http_client_initialize().


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