Home Explore Help
Sign In
OWEALs
/
curl
mirror of https://github.com/curl/curl.git
2
0
Fork 0
Files Issues 8 Wiki
Tree: 58c4b8d636
Branches Tags
curl
/
docs
/
libcurl
/
opts
/
CURLOPT_TCP_FASTOPEN.3

CURLOPT_TCP_FASTOPEN.3 2.1 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 
  1. .\" **************************************************************************
    2. 

  2. .\" *                                  _   _ ____  _
    3. 

  3. .\" *  Project                     ___| | | |  _ \| |
    4. 

  4. .\" *                             / __| | | | |_) | |
    5. 

  5. .\" *                            | (__| |_| |  _ <| |___
    6. 

  6. .\" *                             \___|\___/|_| \_\_____|
    7. 

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
    9. 

  9. .\" *
    10. 

  10. .\" * This software is licensed as described in the file COPYING, which
    11. 

  11. .\" * you should have received as part of this distribution. The terms
    12. 

  12. .\" * are also available at https://curl.se/docs/copyright.html.
    13. 

  13. .\" *
    14. 

  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
    15. 

  15. .\" * copies of the Software, and permit persons to whom the Software is
    16. 

  16. .\" * furnished to do so, under the terms of the COPYING file.
    17. 

  17. .\" *
    18. 

  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
    19. 

  19. .\" * KIND, either express or implied.
    20. 

  20. .\" *
    21. 

  21. .\" **************************************************************************
    22. 

  22. .\"
    23. 

  23. .TH CURLOPT_TCP_FASTOPEN 3 "16 Feb 2016" "libcurl 7.49.0" "curl_easy_setopt options"
    24. 

  24. .SH NAME
    25. 

  25. CURLOPT_TCP_FASTOPEN \- enable TCP Fast Open
    26. 

  26. .SH SYNOPSIS
    27. 

  27. #include <curl/curl.h>
    28. 

  28. 

  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_FASTOPEN, long enable);
    30. 

  30. .SH DESCRIPTION
    31. 

  31. Pass a long as parameter set to 1L to enable or 0 to disable.
    32. 

  32. 

  33. TCP Fast Open (RFC7413) is a mechanism that allows data to be carried in the
    34. 

  34. SYN and SYN-ACK packets and consumed by the receiving end during the initial
    35. 

  35. connection handshake, saving up to one full round-trip time (RTT).
    36. 

  36. .SH DEFAULT
    37. 

  37. 0
    38. 

  38. .SH PROTOCOLS
    39. 

  39. All
    40. 

  40. .SH EXAMPLE
    41. 

  41. .nf
    42. 

  42. CURL *curl = curl_easy_init();
    43. 

  43. if(curl) {
    44. 

  44.   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
    45. 

  45.   curl_easy_setopt(curl, CURLOPT_TCP_FASTOPEN, 1L);
    46. 

  46.   curl_easy_perform(curl);
    47. 

  47. }
    48. 

  48. .fi
    49. 

  49. .SH AVAILABILITY
    50. 

  50. Added in 7.49.0. This option is currently only supported on Linux and  OS X
    51. 

  51. El Capitan.
    52. 

  52. .SH RETURN VALUE
    53. 

  53. Returns CURLE_OK if fast open is supported by the operating system, otherwise
    54. 

  54. returns CURLE_NOT_BUILT_IN.
    55.