docs/libcurl/opts/CURLOPT_DNS_USE_GLOBAL_CACHE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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_DNS_USE_GLOBAL_CACHE 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_DNS_USE_GLOBAL_CACHE \- enable/disable global DNS cache
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_USE_GLOBAL_CACHE,
  31                           long enable);
  32 .SH DESCRIPTION
  33 Pass a long. If the \fIenable\fP value is 1, it tells curl to use a global DNS
  34 cache that will survive between easy handle creations and deletions. This is
  35 not thread-safe and this will use a global variable.
  36
  37 \fBWARNING:\fP this option is considered obsolete. Stop using it. Switch over
  38 to using the share interface instead! See \fICURLOPT_SHARE(3)\fP and
  39 \fIcurl_share_init(3)\fP.
  40 .SH DEFAULT
  41 0
  42 .SH PROTOCOLS
  43 All
  44 .SH EXAMPLE
  45 .nf
  46 CURL *curl = curl_easy_init();
  47 if(curl) {
  48   CURLcode ret;
  49   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  50   /* switch off the use of a global, thread unsafe, cache */
  51   curl_easy_setopt(curl, CURLOPT_DNS_USE_GLOBAL_CACHE, 0L);
  52   ret = curl_easy_perform(curl);
  53   curl_easy_cleanup(curl);
  54 }
  55 .fi
  56 .SH AVAILABILITY
  57 Subject for removal in the future. Do not use!
  58 .SH RETURN VALUE
  59 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  60 .SH "SEE ALSO"
  61 .BR CURLOPT_SHARE "(3), " CURLOPT_DNS_CACHE_TIMEOUT "(3), "