azure-core
Public Attributes | List of all members
Azure::Core::Http::CurlTransportOptions Struct Referencefinal

Set the libcurl connection options like a proxy and CA path.

#include <curl_transport.hpp>

Public Attributes

Azure::Nullable< std::string > Proxy
 The string for the proxy is passed directly to the libcurl handle without any parsing. More...
 
std::string CAInfo
 The string for the certificate authenticator is sent to libcurl handle directly. More...
 
bool HttpKeepAlive = true
 All HTTP requests will keep the connection channel open to the service. More...
 
bool SslVerifyPeer = true
 This option determines whether libcurl verifies the authenticity of the peer's certificate. More...
 
CurlTransportSslOptions SslOptions
 Define the SSL options for the libcurl handle. More...
 
bool NoSignal = false
 When true, libcurl will not use any functions that install signal handlers or any functions that cause signals to be sent to the process. More...
 
std::chrono::milliseconds ConnectionTimeout = _detail::DefaultConnectionTimeout
 Contain the maximum time that you allow the connection phase to the server to take. More...
 

Member Data Documentation

◆ CAInfo

std::string Azure::Core::Http::CurlTransportOptions::CAInfo
Remarks
The Azure SDK will not check if the path is valid or not.
The default is the built-in system specific path. More about this option: https://curl.haxx.se/libcurl/c/CURLOPT_CAINFO.html

◆ ConnectionTimeout

std::chrono::milliseconds Azure::Core::Http::CurlTransportOptions::ConnectionTimeout = _detail::DefaultConnectionTimeout

This only limits the connection phase, it has no impact once it has connected.

Remarks
The default timeout is 300 seconds and using 0 would set this default value.

◆ HttpKeepAlive

bool Azure::Core::Http::CurlTransportOptions::HttpKeepAlive = true
Remarks
The channel might be closed by the server if the server response has an error code. A connection won't be re-used if it is abandoned in the middle of an operation. operation.
This option is managed directly by the Azure SDK. No option is set for the curl handle. It is true by default.

◆ NoSignal

bool Azure::Core::Http::CurlTransportOptions::NoSignal = false

This option is here to allow multi-threaded unix applications to still set/use all timeout options etc, without risking getting signals.

◆ Proxy

Azure::Nullable<std::string> Azure::Core::Http::CurlTransportOptions::Proxy

libcurl will use system's environment proxy configuration (if it is set) when the Proxy setting is not set (is null). Setting an empty string will make libcurl to ignore any proxy settings from the system (use no proxy).

Remarks
No validation for the string is done by the Azure SDK. More about this option: https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html.
The default value is an empty string (no proxy).

◆ SslOptions

CurlTransportSslOptions Azure::Core::Http::CurlTransportOptions::SslOptions
Remarks
See more info here: https://curl.haxx.se/libcurl/c/CURLOPT_SSL_OPTIONS.html. The default option is all options false.

◆ SslVerifyPeer

bool Azure::Core::Http::CurlTransportOptions::SslVerifyPeer = true
Remarks
The default value is true. More about this option: https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html

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