mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2024-12-15 06:40:09 +08:00
Code Issues Packages Projects Releases Wiki Activity
965119855d
curl/docs/libcurl/opts/CURLOPT_IPRESOLVE.3

68 lines
2.3 KiB
Groff
Raw Normal View History

opts: more man pages
2014-06-19 19:53:13 +08:00
.\" **************************************************************************
.\" * _ _ ____ _
.\" * Project ___| | | | _ \| |
.\" * / __| | | | |_) | |
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
opts docs: unify phrasing in NAME header - avoid writing "set ..." or "enable/disable ..." or "specify ..." *All* options for curl_easy_setopt() are about setting or enabling things and most of the existing options didn't use that way of description. - start with lowercase letter, unless abbreviation. For consistency. - Some additional touch-ups Closes #7688
2021-09-09 04:55:58 +08:00
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
opts: more man pages
2014-06-19 19:53:13 +08:00
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
curl.se: new home Closes #6172
2020-11-04 21:02:01 +08:00
.\" * are also available at https://curl.se/docs/copyright.html.
opts: more man pages
2014-06-19 19:53:13 +08:00
.\" *
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
.\" * copies of the Software, and permit persons to whom the Software is
.\" * furnished to do so, under the terms of the COPYING file.
.\" *
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
.\" **************************************************************************
.\"
.TH CURLOPT_IPRESOLVE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
.SH NAME
opts docs: unify phrasing in NAME header - avoid writing "set ..." or "enable/disable ..." or "specify ..." *All* options for curl_easy_setopt() are about setting or enabling things and most of the existing options didn't use that way of description. - start with lowercase letter, unless abbreviation. For consistency. - Some additional touch-ups Closes #7688
2021-09-09 04:55:58 +08:00
CURLOPT_IPRESOLVE \- IP protocol version to use
opts: more man pages
2014-06-19 19:53:13 +08:00
.SH SYNOPSIS
docs: consistent manpage SYNOPSIS Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
2021-11-26 21:20:18 +08:00
.nf
opts: more man pages
2014-06-19 19:53:13 +08:00
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IPRESOLVE, long resolve);
docs: consistent manpage SYNOPSIS Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
2021-11-26 21:20:18 +08:00
.fi
opts: more man pages
2014-06-19 19:53:13 +08:00
.SH DESCRIPTION
Allows an application to select what kind of IP addresses to use when
CURLOPT_IPRESOLVE: preventing wrong IP version from being used In some situations, it was possible that a transfer was setup to use an specific IP version, but due do DNS caching or connection reuse, it ended up using a different IP version from requested. This commit changes the effect of CURLOPT_IPRESOLVE from simply restricting address resolution to preventing the wrong connection type being used, when choosing a connection from the pool, and to restricting what addresses could be used when establishing a new connection. It is important that all addresses versions are resolved, even if not used in that transfer in particular, because the result is cached, and could be useful for a different transfer with a different CURLOPT_IPRESOLVE setting. Closes #6853
2021-04-25 03:04:53 +08:00
establishing a connection or choosing one from the connection pool. This is
interesting when using host names that resolve addresses using more than
one version of IP. The allowed values are:
opts: more man pages
2014-06-19 19:53:13 +08:00
.IP CURL_IPRESOLVE_WHATEVER
CURLOPT_IPRESOLVE: preventing wrong IP version from being used In some situations, it was possible that a transfer was setup to use an specific IP version, but due do DNS caching or connection reuse, it ended up using a different IP version from requested. This commit changes the effect of CURLOPT_IPRESOLVE from simply restricting address resolution to preventing the wrong connection type being used, when choosing a connection from the pool, and to restricting what addresses could be used when establishing a new connection. It is important that all addresses versions are resolved, even if not used in that transfer in particular, because the result is cached, and could be useful for a different transfer with a different CURLOPT_IPRESOLVE setting. Closes #6853
2021-04-25 03:04:53 +08:00
Default, can use addresses of all IP versions that your system allows.
opts: more man pages
2014-06-19 19:53:13 +08:00
.IP CURL_IPRESOLVE_V4
CURLOPT_IPRESOLVE: preventing wrong IP version from being used In some situations, it was possible that a transfer was setup to use an specific IP version, but due do DNS caching or connection reuse, it ended up using a different IP version from requested. This commit changes the effect of CURLOPT_IPRESOLVE from simply restricting address resolution to preventing the wrong connection type being used, when choosing a connection from the pool, and to restricting what addresses could be used when establishing a new connection. It is important that all addresses versions are resolved, even if not used in that transfer in particular, because the result is cached, and could be useful for a different transfer with a different CURLOPT_IPRESOLVE setting. Closes #6853
2021-04-25 03:04:53 +08:00
Uses only IPv4 addresses.
opts: more man pages
2014-06-19 19:53:13 +08:00
.IP CURL_IPRESOLVE_V6
CURLOPT_IPRESOLVE: preventing wrong IP version from being used In some situations, it was possible that a transfer was setup to use an specific IP version, but due do DNS caching or connection reuse, it ended up using a different IP version from requested. This commit changes the effect of CURLOPT_IPRESOLVE from simply restricting address resolution to preventing the wrong connection type being used, when choosing a connection from the pool, and to restricting what addresses could be used when establishing a new connection. It is important that all addresses versions are resolved, even if not used in that transfer in particular, because the result is cached, and could be useful for a different transfer with a different CURLOPT_IPRESOLVE setting. Closes #6853
2021-04-25 03:04:53 +08:00
Uses only IPv6 addresses.
opts: more man pages
2014-06-19 19:53:13 +08:00
.SH DEFAULT
CURL_IPRESOLVE_WHATEVER
.SH PROTOCOLS
All
.SH EXAMPLE
docs/opts: 24 more man pages now have examples
2017-05-05 23:26:08 +08:00
.nf
CURL *curl = curl_easy_init();
if(curl) {
man pages: switch to https://example.com URLs Since HTTPS is "the new normal", this update changes a lot of man page examples to use https://example.com instead of the previous "http://..." Closes #5969
2020-09-17 05:04:07 +08:00
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
docs/opts: 24 more man pages now have examples
2017-05-05 23:26:08 +08:00
CURLOPT_IPRESOLVE: preventing wrong IP version from being used In some situations, it was possible that a transfer was setup to use an specific IP version, but due do DNS caching or connection reuse, it ended up using a different IP version from requested. This commit changes the effect of CURLOPT_IPRESOLVE from simply restricting address resolution to preventing the wrong connection type being used, when choosing a connection from the pool, and to restricting what addresses could be used when establishing a new connection. It is important that all addresses versions are resolved, even if not used in that transfer in particular, because the result is cached, and could be useful for a different transfer with a different CURLOPT_IPRESOLVE setting. Closes #6853
2021-04-25 03:04:53 +08:00
/* of all addresses example.com resolves to, only IPv6 ones are used */
docs/opts: 24 more man pages now have examples
2017-05-05 23:26:08 +08:00
curl_easy_setopt(curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V6);
ret = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
.fi
opts: more man pages
2014-06-19 19:53:13 +08:00
.SH AVAILABILITY
Always
.SH RETURN VALUE
Returns CURLE_OK
.SH "SEE ALSO"
.BR CURLOPT_HTTP_VERSION "(3), " CURLOPT_SSLVERSION "(3), "
Reference in New Issue Copy Permalink