CURLOPT_DNS_CACHE_TIMEOUT.3 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_DNS_CACHE_TIMEOUT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_DNS_CACHE_TIMEOUT \- life-time for DNS cache entries
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_CACHE_TIMEOUT, long age);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a long, this sets the timeout in seconds. Name resolves will be kept in
  33. memory and used for this number of seconds. Set to zero to completely disable
  34. caching, or set to -1 to make the cached entries remain forever. By default,
  35. libcurl caches this info for 60 seconds.
  36. The name resolve functions of various libc implementations do not re-read name
  37. server information unless explicitly told so (for example, by calling
  38. \fIres_init(3)\fP). This may cause libcurl to keep using the older server even
  39. if DHCP has updated the server info, and this may look like a DNS cache issue
  40. to the casual libcurl-app user.
  41. Note that DNS entries have a "TTL" property but libcurl does not use that. This
  42. DNS cache timeout is entirely speculative that a name will resolve to the same
  43. address for a certain small amount of time into the future.
  44. .SH DEFAULT
  45. 60
  46. .SH PROTOCOLS
  47. All
  48. .SH EXAMPLE
  49. .nf
  50. CURL *curl = curl_easy_init();
  51. if(curl) {
  52. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
  53. /* only reuse addresses for a short time */
  54. curl_easy_setopt(curl, CURLOPT_DNS_CACHE_TIMEOUT, 2L);
  55. ret = curl_easy_perform(curl);
  56. /* in this second request, the cache will not be used if more than
  57. two seconds have passed since the previous name resolve */
  58. ret = curl_easy_perform(curl);
  59. curl_easy_cleanup(curl);
  60. }
  61. .fi
  62. .SH AVAILABILITY
  63. Always
  64. .SH RETURN VALUE
  65. Returns CURLE_OK
  66. .SH "SEE ALSO"
  67. .BR CURLOPT_DNS_USE_GLOBAL_CACHE "(3), " CURLOPT_DNS_SERVERS "(3), "
  68. .BR CURLOPT_RESOLVE "(3), "