Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TCP_FASTOPEN.3, revision 1.1.1.1
1.1 misho 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_TCP_FASTOPEN 3 "May 15, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_TCP_FASTOPEN \- enable TCP Fast Open
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_FASTOPEN, long enable);
31: .SH DESCRIPTION
32: Pass a long as parameter set to 1L to enable or 0 to disable.
33:
34: TCP Fast Open (RFC7413) is a mechanism that allows data to be carried in the
35: SYN and SYN-ACK packets and consumed by the receiving end during the initial
36: connection handshake, saving up to one full round-trip time (RTT).
37: .SH DEFAULT
38: 0
39: .SH PROTOCOLS
40: All
41: .SH EXAMPLE
42: .nf
43: CURL *curl = curl_easy_init();
44: if(curl) {
45: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
46: curl_easy_setopt(curl, CURLOPT_TCP_FASTOPEN, 1L);
47: curl_easy_perform(curl);
48: }
49: .fi
50: .SH AVAILABILITY
51: Added in 7.49.0. This option is currently only supported on Linux and OS X
52: El Capitan.
53: .SH RETURN VALUE
54: Returns CURLE_OK if fast open is supported by the operating system, otherwise
55: returns CURLE_NOT_BUILT_IN.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>