CURLOPT_TCP_KEEPINTVL.3 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLOPT_TCP_KEEPINTVL 3 "19 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_TCP_KEEPINTVL \- TCP keep-alive interval
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_KEEPINTVL, long interval);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a long. Sets the interval, in seconds, that the operating system will
  35. wait between sending keepalive probes. Not all operating systems support this
  36. option. (Added in 7.25.0)
  37. The maximum value this accepts is 2147483648. Any larger value will be capped
  38. to this amount.
  39. .SH DEFAULT
  40. 60
  41. .SH PROTOCOLS
  42. All
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  48. /* enable TCP keep-alive for this transfer */
  49. curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);
  50. /* set keep-alive idle time to 120 seconds */
  51. curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);
  52. /* interval time between keep-alive probes: 60 seconds */
  53. curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);
  54. curl_easy_perform(curl);
  55. }
  56. .fi
  57. .SH AVAILABILITY
  58. Always
  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_KEEPIDLE "(3), "