Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TCP_KEEPIDLE.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_KEEPIDLE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_TCP_KEEPIDLE \- set TCP keep-alive idle time wait
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_KEEPIDLE, long delay);
! 31: .SH DESCRIPTION
! 32: Pass a long. Sets the \fIdelay\fP, in seconds, that the operating system will
! 33: wait while the connection is idle before sending keepalive probes. Not all
! 34: operating systems support this option.
! 35: .SH DEFAULT
! 36: 60
! 37: .SH PROTOCOLS
! 38: All
! 39: .SH EXAMPLE
! 40: .nf
! 41: CURL *curl = curl_easy_init();
! 42: if(curl) {
! 43: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
! 44:
! 45: /* enable TCP keep-alive for this transfer */
! 46: curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);
! 47:
! 48: /* set keep-alive idle time to 120 seconds */
! 49: curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);
! 50:
! 51: /* interval time between keep-alive probes: 60 seconds */
! 52: curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);
! 53:
! 54: curl_easy_perform(curl);
! 55: }
! 56: .fi
! 57: .SH AVAILABILITY
! 58: Added in 7.25.0
! 59: .SH RETURN VALUE
! 60: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
! 61: .SH "SEE ALSO"
! 62: .BR CURLOPT_TCP_KEEPALIVE "(3), " CURLOPT_TCP_KEEPINTVL "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>