CURLOPT_SSL_FALSESTART.3 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  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_SSL_FALSESTART 3 "14 Feb 2015" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_SSL_FALSESTART \- TLS false start
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_FALSESTART, long enable);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a long as parameter set to 1L to enable or 0 to disable.
  35. This option determines whether libcurl should use false start during the TLS
  36. handshake. False start is a mode where a TLS client will start sending
  37. application data before verifying the server's Finished message, thus saving a
  38. round trip when performing a full handshake.
  39. .SH DEFAULT
  40. 0
  41. .SH PROTOCOLS
  42. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  48. curl_easy_setopt(curl, CURLOPT_SSL_FALSESTART, 1L);
  49. curl_easy_perform(curl);
  50. }
  51. .fi
  52. .SH AVAILABILITY
  53. Added in 7.42.0. This option is currently only supported by the NSS and
  54. Secure Transport (on iOS 7.0 or later, or OS X 10.9 or later) TLS backends.
  55. .SH RETURN VALUE
  56. Returns CURLE_OK if false start is supported by the SSL backend, otherwise
  57. returns CURLE_NOT_BUILT_IN.
  58. .SH SEE ALSO
  59. .BR CURLOPT_TCP_FASTOPEN "(3), "