CURLOPT_HTTP_VERSION.3 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, 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.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLOPT_HTTP_VERSION 3 "January 09, 2023" "libcurl 7.88.1" "curl_easy_setopt options"
  26. .SH NAME
  27. CURLOPT_HTTP_VERSION \- HTTP protocol version to use
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP_VERSION, long version);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass \fIversion\fP a long, set to one of the values described below. They ask
  35. libcurl to use the specific HTTP versions.
  36. Note that the HTTP version is just a request. libcurl will still prioritize to
  37. re-use an existing connection so it might then re-use a connection using a
  38. HTTP version you have not asked for.
  39. .IP CURL_HTTP_VERSION_NONE
  40. We do not care about what version the library uses. libcurl will use whatever
  41. it thinks fit.
  42. .IP CURL_HTTP_VERSION_1_0
  43. Enforce HTTP 1.0 requests.
  44. .IP CURL_HTTP_VERSION_1_1
  45. Enforce HTTP 1.1 requests.
  46. .IP CURL_HTTP_VERSION_2_0
  47. Attempt HTTP 2 requests. libcurl will fall back to HTTP 1.1 if HTTP 2 cannot be
  48. negotiated with the server. (Added in 7.33.0)
  49. When libcurl uses HTTP/2 over HTTPS, it does not itself insist on TLS 1.2 or
  50. higher even though that is required by the specification. A user can add this
  51. version requirement with \fICURLOPT_SSLVERSION(3)\fP.
  52. The alias \fICURL_HTTP_VERSION_2\fP was added in 7.43.0 to better reflect the
  53. actual protocol name.
  54. .IP CURL_HTTP_VERSION_2TLS
  55. Attempt HTTP 2 over TLS (HTTPS) only. libcurl will fall back to HTTP 1.1 if
  56. HTTP 2 cannot be negotiated with the HTTPS server. For clear text HTTP servers,
  57. libcurl will use 1.1. (Added in 7.47.0)
  58. .IP CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE
  59. Issue non-TLS HTTP requests using HTTP/2 without HTTP/1.1 Upgrade. It requires
  60. prior knowledge that the server supports HTTP/2 straight away. HTTPS requests
  61. will still do HTTP/2 the standard way with negotiated protocol version in the
  62. TLS handshake. (Added in 7.49.0)
  63. .IP CURL_HTTP_VERSION_3
  64. (Added in 7.66.0) This option makes libcurl attempt to use HTTP/3 to the host
  65. given in the URL, with fallback to earlier HTTP versions if needed.
  66. .IP CURL_HTTP_VERSION_3ONLY
  67. (Added in 7.88.0) Setting this value will make libcurl attempt to use HTTP/3
  68. directly to server given in the URL but will not downgrade to earlier HTTP
  69. version if the server does not support HTTP/3.
  70. .SH DEFAULT
  71. Since curl 7.62.0: CURL_HTTP_VERSION_2TLS
  72. Before that: CURL_HTTP_VERSION_1_1
  73. .SH PROTOCOLS
  74. HTTP
  75. .SH EXAMPLE
  76. .nf
  77. CURL *curl = curl_easy_init();
  78. if(curl) {
  79. CURLcode ret;
  80. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  81. curl_easy_setopt(curl, CURLOPT_HTTP_VERSION,
  82. (long)CURL_HTTP_VERSION_2TLS);
  83. ret = curl_easy_perform(curl);
  84. if(ret == CURLE_HTTP_RETURNED_ERROR) {
  85. /* an HTTP response error problem */
  86. }
  87. }
  88. .fi
  89. .SH AVAILABILITY
  90. Along with HTTP
  91. .SH RETURN VALUE
  92. Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  93. .SH "SEE ALSO"
  94. .BR CURLOPT_SSLVERSION "(3), " CURLOPT_HTTP200ALIASES "(3), "
  95. .BR CURLOPT_HTTP09_ALLOWED "(3), " CURLOPT_ALTSVC "(3) "