mirror of
https://github.com/moparisthebest/curl
synced 2024-11-16 14:35:03 -05:00
57 lines
2.3 KiB
Groff
57 lines
2.3 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) 1998 - 2014, 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 http://curl.haxx.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_NODELAY 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_TCP_NODELAY \- set the TCP_NODELAY option
|
||
|
|
.SH SYNOPSIS
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_NODELAY, long nodelay);
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Pass a long specifying whether the TCP_NODELAY option is to be set or cleared
|
||
|
|
(1 = set, 0 = clear). The option is cleared by default. This will have no
|
||
|
|
effect after the connection has been established.
|
||
|
|
|
||
|
|
Setting this option will disable TCP's Nagle algorithm. The purpose of this
|
||
|
|
algorithm is to try to minimize the number of small packets on the network
|
||
|
|
(where "small packets" means TCP segments less than the Maximum Segment Size
|
||
|
|
(MSS) for the network).
|
||
|
|
|
||
|
|
Maximizing the amount of data sent per TCP segment is good because it
|
||
|
|
amortizes the overhead of the send. However, in some cases small segments may
|
||
|
|
need to be sent without delay. This is less efficient than sending larger
|
||
|
|
amounts of data at a time, and can contribute to congestion on the network if
|
||
|
|
overdone.
|
||
|
|
.SH DEFAULT
|
||
|
|
0
|
||
|
|
.SH PROTOCOLS
|
||
|
|
All
|
||
|
|
.SH EXAMPLE
|
||
|
|
TODO
|
||
|
|
.SH AVAILABILITY
|
||
|
|
Always
|
||
|
|
.SH RETURN VALUE
|
||
|
|
Returns CURLE_OK
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_TCP_KEEPALIVE "(3), "
|