docs/libcurl/opts/CURLOPT_DNS_CACHE_TIMEOUT.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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_DNS_CACHE_TIMEOUT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_DNS_CACHE_TIMEOUT \- set life-time for DNS cache entries
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_CACHE_TIMEOUT, long age);
  30 .SH DESCRIPTION
  31 Pass a long, this sets the timeout in seconds. Name resolves will be kept in
  32 memory and used for this number of seconds. Set to zero to completely disable
  33 caching, or set to -1 to make the cached entries remain forever. By default,
  34 libcurl caches this info for 60 seconds.
  35
  36 The name resolve functions of various libc implementations don't 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
  42 Note that DNS entries have a "TTL" property but libcurl doesn't use that. This
  43 DNS cache timeout is entirely speculative that a name will resolve to the same
  44 address for a certain small amount of time into the future.
  45 .SH DEFAULT
  46 60
  47 .SH PROTOCOLS
  48 All
  49 .SH EXAMPLE
  50 TODO
  51 .SH AVAILABILITY
  52 Always
  53 .SH RETURN VALUE
  54 Returns CURLE_OK
  55 .SH "SEE ALSO"
  56 .BR CURLOPT_DNS_USE_GLOBAL_CACHE "(3), " CURLOPT_DNS_SERVERS "(3), "