CURLOPT_TCP_FASTOPEN.3 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_TCP_FASTOPEN 3 "16 Feb 2016" "libcurl 7.49.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_TCP_FASTOPEN \- TCP Fast Open
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_FASTOPEN, long enable);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a long as parameter set to 1L to enable or 0 to disable.
  33. TCP Fast Open (RFC7413) is a mechanism that allows data to be carried in the
  34. SYN and SYN-ACK packets and consumed by the receiving end during the initial
  35. connection handshake, saving up to one full round-trip time (RTT).
  36. .SH DEFAULT
  37. 0
  38. .SH PROTOCOLS
  39. All
  40. .SH EXAMPLE
  41. .nf
  42. CURL *curl = curl_easy_init();
  43. if(curl) {
  44. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  45. curl_easy_setopt(curl, CURLOPT_TCP_FASTOPEN, 1L);
  46. curl_easy_perform(curl);
  47. }
  48. .fi
  49. .SH AVAILABILITY
  50. Added in 7.49.0. This option is currently only supported on Linux and OS X
  51. El Capitan.
  52. .SH RETURN VALUE
  53. Returns CURLE_OK if fast open is supported by the operating system, otherwise
  54. returns CURLE_NOT_BUILT_IN.
  55. .SH SEE ALSO
  56. .BR CURLOPT_SSL_FALSESTART "(3), "