CURLOPT_HTTP_VERSION.3 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2017, 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 "April 17, 2018" "libcurl 7.61.1" "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. This is not sensible to do unless
  32. you have a good reason. You have to set this option if you want to use
  33. libcurl's HTTP/2 support.
  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. .IP CURL_HTTP_VERSION_NONE
  38. We don't care about what version the library uses. libcurl will use whatever
  39. it thinks fit.
  40. .IP CURL_HTTP_VERSION_1_0
  41. Enforce HTTP 1.0 requests.
  42. .IP CURL_HTTP_VERSION_1_1
  43. Enforce HTTP 1.1 requests.
  44. .IP CURL_HTTP_VERSION_2_0
  45. Attempt HTTP 2 requests. libcurl will fall back to HTTP 1.1 if HTTP 2 can't be
  46. negotiated with the server. (Added in 7.33.0)
  47. The alias \fICURL_HTTP_VERSION_2\fP was added in 7.43.0 to better reflect the
  48. actual protocol name.
  49. .IP CURL_HTTP_VERSION_2TLS
  50. Attempt HTTP 2 over TLS (HTTPS) only. libcurl will fall back to HTTP 1.1 if
  51. HTTP 2 can't be negotiated with the HTTPS server. For clear text HTTP servers,
  52. libcurl will use 1.1. (Added in 7.47.0)
  53. .IP CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE
  54. Issue non-TLS HTTP requests using HTTP/2 without HTTP/1.1 Upgrade. It requires
  55. prior knowledge that the server supports HTTP/2 straight away. HTTPS requests
  56. will still do HTTP/2 the standard way with negotiated protocol version in the
  57. TLS handshake. (Added in 7.49.0)
  58. .SH DEFAULT
  59. CURL_HTTP_VERSION_NONE
  60. .SH PROTOCOLS
  61. HTTP
  62. .SH EXAMPLE
  63. .nf
  64. CURL *curl = curl_easy_init();
  65. if(curl) {
  66. CURLcode ret;
  67. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  68. curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2TLS);
  69. ret = curl_easy_perform(curl);
  70. if(ret == CURLE_HTTP_RETURNED_ERROR) {
  71. /* an HTTP response error problem */
  72. }
  73. }
  74. .fi
  75. .SH AVAILABILITY
  76. Along with HTTP
  77. .SH RETURN VALUE
  78. Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  79. .SH "SEE ALSO"
  80. .BR CURLOPT_SSLVERSION "(3), " CURLOPT_HTTP200ALIASES "(3), "