| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_HTTP_VERSION 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_HTTP_VERSION \- specify HTTP protocol version to use |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP_VERSION, long version); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass \fIversion\fP a long, set to one of the values described below. They ask |
| 32 |
libcurl to use the specific HTTP versions. |
| 33 |
|
| 34 |
Note that the HTTP version is just a request. libcurl will still prioritize to |
| 35 |
re-use an existing connection so it might then re-use a connection using a |
| 36 |
HTTP version you haven't asked for. |
| 37 |
|
| 38 |
.IP CURL_HTTP_VERSION_NONE |
| 39 |
We don't care about what version the library uses. libcurl will use whatever |
| 40 |
it thinks fit. |
| 41 |
.IP CURL_HTTP_VERSION_1_0 |
| 42 |
Enforce HTTP 1.0 requests. |
| 43 |
.IP CURL_HTTP_VERSION_1_1 |
| 44 |
Enforce HTTP 1.1 requests. |
| 45 |
.IP CURL_HTTP_VERSION_2_0 |
| 46 |
Attempt HTTP 2 requests. libcurl will fall back to HTTP 1.1 if HTTP 2 can't be |
| 47 |
negotiated with the server. (Added in 7.33.0) |
| 48 |
|
| 49 |
The alias \fICURL_HTTP_VERSION_2\fP was added in 7.43.0 to better reflect the |
| 50 |
actual protocol name. |
| 51 |
.IP CURL_HTTP_VERSION_2TLS |
| 52 |
Attempt HTTP 2 over TLS (HTTPS) only. libcurl will fall back to HTTP 1.1 if |
| 53 |
HTTP 2 can't be negotiated with the HTTPS server. For clear text HTTP servers, |
| 54 |
libcurl will use 1.1. (Added in 7.47.0) |
| 55 |
.IP CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE |
| 56 |
Issue non-TLS HTTP requests using HTTP/2 without HTTP/1.1 Upgrade. It requires |
| 57 |
prior knowledge that the server supports HTTP/2 straight away. HTTPS requests |
| 58 |
will still do HTTP/2 the standard way with negotiated protocol version in the |
| 59 |
TLS handshake. (Added in 7.49.0) |
| 60 |
.IP CURL_HTTP_VERSION_3 |
| 61 |
(Added in 7.66.0) Setting this value will make libcurl attempt to use HTTP/3 |
| 62 |
directly to server given in the URL. Note that this cannot gracefully |
| 63 |
downgrade to earlier HTTP version if the server doesn't support HTTP/3. |
| 64 |
|
| 65 |
For more reliably upgrading to HTTP/3, set the preferred version to something |
| 66 |
lower and let the server announce its HTTP/3 support via Alt-Svc:. See |
| 67 |
\fICURLOPT_ALTSVC(3)\fP. |
| 68 |
.SH DEFAULT |
| 69 |
Since curl 7.62.0: CURL_HTTP_VERSION_2TLS |
| 70 |
|
| 71 |
Before that: CURL_HTTP_VERSION_1_1 |
| 72 |
.SH PROTOCOLS |
| 73 |
HTTP |
| 74 |
.SH EXAMPLE |
| 75 |
.nf |
| 76 |
CURL *curl = curl_easy_init(); |
| 77 |
if(curl) { |
| 78 |
CURLcode ret; |
| 79 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); |
| 80 |
curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2TLS); |
| 81 |
ret = curl_easy_perform(curl); |
| 82 |
if(ret == CURLE_HTTP_RETURNED_ERROR) { |
| 83 |
/* an HTTP response error problem */ |
| 84 |
} |
| 85 |
} |
| 86 |
.fi |
| 87 |
.SH AVAILABILITY |
| 88 |
Along with HTTP |
| 89 |
.SH RETURN VALUE |
| 90 |
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
| 91 |
.SH "SEE ALSO" |
| 92 |
.BR CURLOPT_SSLVERSION "(3), " CURLOPT_HTTP200ALIASES "(3), " |
| 93 |
.BR CURLOPT_HTTP09_ALLOWED "(3), " CURLOPT_ALTSVC "(3) " |