CURLOPT_HTTP_VERSION.3 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2019, 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.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. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP_VERSION, long version);
  29. .SH DESCRIPTION
  30. Pass \fIversion\fP a long, set to one of the values described below. They ask
  31. libcurl to use the specific HTTP versions.
  32. Note that the HTTP version is just a request. libcurl will still prioritize to
  33. re-use an existing connection so it might then re-use a connection using a
  34. HTTP version you haven't asked for.
  35. .IP CURL_HTTP_VERSION_NONE
  36. We don't care about what version the library uses. libcurl will use whatever
  37. it thinks fit.
  38. .IP CURL_HTTP_VERSION_1_0
  39. Enforce HTTP 1.0 requests.
  40. .IP CURL_HTTP_VERSION_1_1
  41. Enforce HTTP 1.1 requests.
  42. .IP CURL_HTTP_VERSION_2_0
  43. Attempt HTTP 2 requests. libcurl will fall back to HTTP 1.1 if HTTP 2 can't be
  44. negotiated with the server. (Added in 7.33.0)
  45. The alias \fICURL_HTTP_VERSION_2\fP was added in 7.43.0 to better reflect the
  46. actual protocol name.
  47. .IP CURL_HTTP_VERSION_2TLS
  48. Attempt HTTP 2 over TLS (HTTPS) only. libcurl will fall back to HTTP 1.1 if
  49. HTTP 2 can't be negotiated with the HTTPS server. For clear text HTTP servers,
  50. libcurl will use 1.1. (Added in 7.47.0)
  51. .IP CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE
  52. Issue non-TLS HTTP requests using HTTP/2 without HTTP/1.1 Upgrade. It requires
  53. prior knowledge that the server supports HTTP/2 straight away. HTTPS requests
  54. will still do HTTP/2 the standard way with negotiated protocol version in the
  55. TLS handshake. (Added in 7.49.0)
  56. .IP CURL_HTTP_VERSION_3
  57. (Added in 7.66.0) Setting this value will make libcurl attempt to use HTTP/3
  58. directly to server given in the URL. Note that this cannot gracefully
  59. downgrade to earlier HTTP version if the server doesn't support HTTP/3.
  60. For more reliably upgrading to HTTP/3, set the prefered version to something
  61. lower and let the server announce its HTTP/3 support via Alt-Svc:. See
  62. \fICURLOPT_ALTSVC(3)\fP.
  63. .SH DEFAULT
  64. Since curl 7.62.0: CURL_HTTP_VERSION_2TLS
  65. Before that: CURL_HTTP_VERSION_1_1
  66. .SH PROTOCOLS
  67. HTTP
  68. .SH EXAMPLE
  69. .nf
  70. CURL *curl = curl_easy_init();
  71. if(curl) {
  72. CURLcode ret;
  73. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  74. curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2TLS);
  75. ret = curl_easy_perform(curl);
  76. if(ret == CURLE_HTTP_RETURNED_ERROR) {
  77. /* an HTTP response error problem */
  78. }
  79. }
  80. .fi
  81. .SH AVAILABILITY
  82. Along with HTTP
  83. .SH RETURN VALUE
  84. Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  85. .SH "SEE ALSO"
  86. .BR CURLOPT_SSLVERSION "(3), " CURLOPT_HTTP200ALIASES "(3), "
  87. .BR CURLOPT_HTTP09_ALLOWED "(3), " CURLOPT_ALTSVC "(3) "