CURLOPT_SSL_FALSESTART.3 2.2 KB

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