mirror of
https://github.com/moparisthebest/curl
synced 2024-11-16 06:25:03 -05:00
55 lines
2.1 KiB
Groff
55 lines
2.1 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_TCP_FASTOPEN 3 "16 Feb 2016" "libcurl 7.49.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_TCP_FASTOPEN \- enable TCP Fast Open
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_FASTOPEN, long enable);
|
|
.SH DESCRIPTION
|
|
Pass a long as parameter set to 1L to enable or 0 to disable.
|
|
|
|
TCP Fast Open (RFC7413) is a mechanism that allows data to be carried in the
|
|
SYN and SYN-ACK packets and consumed by the receiving end during the initial
|
|
connection handshake, saving up to one full round-trip time (RTT).
|
|
.SH DEFAULT
|
|
0
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
curl_easy_setopt(curl, CURLOPT_TCP_FASTOPEN, 1L);
|
|
curl_easy_perform(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.49.0. This option is currently only supported on Linux and OS X
|
|
El Capitan.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if fast open is supported by the operating system, otherwise
|
|
returns CURLE_NOT_BUILT_IN.
|