CURLOPT_IPRESOLVE.3 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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_IPRESOLVE 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_setopt options"
  26. .SH NAME
  27. CURLOPT_IPRESOLVE \- IP protocol version to use
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IPRESOLVE, long resolve);
  32. .fi
  33. .SH DESCRIPTION
  34. Allows an application to select what kind of IP addresses to use when
  35. establishing a connection or choosing one from the connection pool. This is
  36. interesting when using host names that resolve addresses using more than
  37. one version of IP. The allowed values are:
  38. .IP CURL_IPRESOLVE_WHATEVER
  39. Default, can use addresses of all IP versions that your system allows.
  40. .IP CURL_IPRESOLVE_V4
  41. Uses only IPv4 addresses.
  42. .IP CURL_IPRESOLVE_V6
  43. Uses only IPv6 addresses.
  44. .SH DEFAULT
  45. CURL_IPRESOLVE_WHATEVER
  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. /* of all addresses example.com resolves to, only IPv6 ones are used */
  54. curl_easy_setopt(curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V6);
  55. ret = curl_easy_perform(curl);
  56. curl_easy_cleanup(curl);
  57. }
  58. .fi
  59. .SH AVAILABILITY
  60. Always
  61. .SH RETURN VALUE
  62. Returns CURLE_OK
  63. .SH "SEE ALSO"
  64. .BR CURLOPT_HTTP_VERSION "(3), " CURLOPT_SSLVERSION "(3), "