Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TCP_NODELAY.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2020, 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_NODELAY 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_TCP_NODELAY \- set the TCP_NODELAY option
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_NODELAY, long nodelay);
! 31: .SH DESCRIPTION
! 32: Pass a long specifying whether the TCP_NODELAY option is to be set or cleared
! 33: (1L = set, 0 = clear). The option is set by default. This will have no effect
! 34: after the connection has been established.
! 35:
! 36: Setting this option to 1L will disable TCP's Nagle algorithm on this
! 37: connection. The purpose of this algorithm is to try to minimize the number of
! 38: small packets on the network (where "small packets" means TCP segments less
! 39: than the Maximum Segment Size (MSS) for the network).
! 40:
! 41: Maximizing the amount of data sent per TCP segment is good because it
! 42: amortizes the overhead of the send. However, in some cases small segments may
! 43: need to be sent without delay. This is less efficient than sending larger
! 44: amounts of data at a time, and can contribute to congestion on the network if
! 45: overdone.
! 46: .SH DEFAULT
! 47: 1
! 48: .SH PROTOCOLS
! 49: All
! 50: .SH EXAMPLE
! 51: .nf
! 52: CURL *curl = curl_easy_init();
! 53: if(curl) {
! 54: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
! 55: /* disable Nagle */
! 56: curl_easy_setopt(curl, CURLOPT_TCP_NODELAY, 0);
! 57: curl_easy_perform(curl);
! 58: }
! 59: .fi
! 60: .SH AVAILABILITY
! 61: Always. The default was changed to 1 from 0 in 7.50.2.
! 62: .SH RETURN VALUE
! 63: Returns CURLE_OK
! 64: .SH "SEE ALSO"
! 65: .BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_TCP_KEEPALIVE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>