CURLINFO_NAMELOOKUP_TIME.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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 CURLINFO_NAMELOOKUP_TIME 3 "28 Aug 2015" libcurl libcurl
  26. .SH NAME
  27. CURLINFO_NAMELOOKUP_TIME \- get the name lookup time
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_NAMELOOKUP_TIME,
  32. double *timep);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a double to receive the total time in seconds from the start
  36. until the name resolving was completed.
  37. When a redirect is followed, the time from each request is added together.
  38. See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
  39. .SH PROTOCOLS
  40. All
  41. .SH EXAMPLE
  42. .nf
  43. curl = curl_easy_init();
  44. if(curl) {
  45. double namelookup;
  46. curl_easy_setopt(curl, CURLOPT_URL, url);
  47. res = curl_easy_perform(curl);
  48. if(CURLE_OK == res) {
  49. res = curl_easy_getinfo(curl, CURLINFO_NAMELOOKUP_TIME, &namelookup);
  50. if(CURLE_OK == res) {
  51. printf("Time: %.1f", namelookup);
  52. }
  53. }
  54. /* always cleanup */
  55. curl_easy_cleanup(curl);
  56. }
  57. .fi
  58. .SH AVAILABILITY
  59. Added in 7.4.1
  60. .SH RETURN VALUE
  61. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62. .SH "SEE ALSO"
  63. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " CURLINFO_NAMELOOKUP_TIME_T "(3)"