mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
83 lines
2.0 KiB
Groff
83 lines
2.0 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_SUPPRESS_CONNECT_HEADERS.md
|
|
.TH CURLOPT_SUPPRESS_CONNECT_HEADERS 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLOPT_SUPPRESS_CONNECT_HEADERS \- suppress proxy CONNECT response headers
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SUPPRESS_CONNECT_HEADERS, long onoff);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
When \fICURLOPT_HTTPPROXYTUNNEL(3)\fP is used and a CONNECT request is made,
|
|
suppress proxy CONNECT response headers from the user callback functions
|
|
\fICURLOPT_HEADERFUNCTION(3)\fP and \fICURLOPT_WRITEFUNCTION(3)\fP.
|
|
|
|
Proxy CONNECT response headers can complicate header processing since it is
|
|
essentially a separate set of headers. You can enable this option to suppress
|
|
those headers.
|
|
|
|
For example let\(aqs assume an HTTPS URL is to be retrieved via CONNECT. On
|
|
success there would normally be two sets of headers, and each header line sent
|
|
to the header function and/or the write function. The data given to the
|
|
callbacks would look like this:
|
|
|
|
.nf
|
|
HTTP/1.1 200 Connection established
|
|
{headers}
|
|
\&...
|
|
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json
|
|
{headers}
|
|
\&...
|
|
|
|
{body}
|
|
\&...
|
|
.fi
|
|
|
|
However by enabling this option the CONNECT response headers are suppressed,
|
|
so the data given to the callbacks would look like this:
|
|
|
|
.nf
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json
|
|
{headers}
|
|
\&...
|
|
|
|
{body}
|
|
\&...
|
|
.fi
|
|
.SH DEFAULT
|
|
0
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
curl_easy_setopt(curl, CURLOPT_HEADER, 1L);
|
|
curl_easy_setopt(curl, CURLOPT_PROXY, "http://foo:3128");
|
|
curl_easy_setopt(curl, CURLOPT_HTTPPROXYTUNNEL, 1L);
|
|
curl_easy_setopt(curl, CURLOPT_SUPPRESS_CONNECT_HEADERS, 1L);
|
|
|
|
curl_easy_perform(curl);
|
|
|
|
/* always cleanup */
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.54.0
|
|
.SH RETURN VALUE
|
|
CURLE_OK or an error such as CURLE_UNKNOWN_OPTION.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_HEADER (3),
|
|
.BR CURLOPT_HTTPPROXYTUNNEL (3),
|
|
.BR CURLOPT_PROXY (3)
|