xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_IPRESOLVE.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: CURLOPT_IPRESOLVE
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_HTTP_VERSION (3)
9*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_RESOLVE (3)
10*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_SSLVERSION (3)
11*6236dae4SAndroid Build Coastguard WorkerProtocol:
12*6236dae4SAndroid Build Coastguard Worker  - All
13*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.10.8
14*6236dae4SAndroid Build Coastguard Worker---
15*6236dae4SAndroid Build Coastguard Worker
16*6236dae4SAndroid Build Coastguard Worker# NAME
17*6236dae4SAndroid Build Coastguard Worker
18*6236dae4SAndroid Build Coastguard WorkerCURLOPT_IPRESOLVE - IP protocol version to use
19*6236dae4SAndroid Build Coastguard Worker
20*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
21*6236dae4SAndroid Build Coastguard Worker
22*6236dae4SAndroid Build Coastguard Worker~~~c
23*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
24*6236dae4SAndroid Build Coastguard Worker
25*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_IPRESOLVE, long resolve);
26*6236dae4SAndroid Build Coastguard Worker~~~
27*6236dae4SAndroid Build Coastguard Worker
28*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
29*6236dae4SAndroid Build Coastguard Worker
30*6236dae4SAndroid Build Coastguard WorkerAllows an application to select what kind of IP addresses to use when
31*6236dae4SAndroid Build Coastguard Workerestablishing a connection or choosing one from the connection pool. This is
32*6236dae4SAndroid Build Coastguard Workerinteresting when using hostnames that resolve to more than one IP family.
33*6236dae4SAndroid Build Coastguard Worker
34*6236dae4SAndroid Build Coastguard WorkerIf the URL provided for a transfer contains a numerical IP version as a host
35*6236dae4SAndroid Build Coastguard Workername, this option does not override or prohibit libcurl from using that IP
36*6236dae4SAndroid Build Coastguard Workerversion.
37*6236dae4SAndroid Build Coastguard Worker
38*6236dae4SAndroid Build Coastguard WorkerAvailable values for this option are:
39*6236dae4SAndroid Build Coastguard Worker
40*6236dae4SAndroid Build Coastguard Worker## CURL_IPRESOLVE_WHATEVER
41*6236dae4SAndroid Build Coastguard Worker
42*6236dae4SAndroid Build Coastguard WorkerDefault, can use addresses of all IP versions that your system allows.
43*6236dae4SAndroid Build Coastguard Worker
44*6236dae4SAndroid Build Coastguard Worker## CURL_IPRESOLVE_V4
45*6236dae4SAndroid Build Coastguard Worker
46*6236dae4SAndroid Build Coastguard WorkerUses only IPv4 addresses.
47*6236dae4SAndroid Build Coastguard Worker
48*6236dae4SAndroid Build Coastguard Worker## CURL_IPRESOLVE_V6
49*6236dae4SAndroid Build Coastguard Worker
50*6236dae4SAndroid Build Coastguard WorkerUses only IPv6 addresses.
51*6236dae4SAndroid Build Coastguard Worker
52*6236dae4SAndroid Build Coastguard Worker# DEFAULT
53*6236dae4SAndroid Build Coastguard Worker
54*6236dae4SAndroid Build Coastguard WorkerCURL_IPRESOLVE_WHATEVER
55*6236dae4SAndroid Build Coastguard Worker
56*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
57*6236dae4SAndroid Build Coastguard Worker
58*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
59*6236dae4SAndroid Build Coastguard Worker
60*6236dae4SAndroid Build Coastguard Worker~~~c
61*6236dae4SAndroid Build Coastguard Workerint main(void)
62*6236dae4SAndroid Build Coastguard Worker{
63*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
64*6236dae4SAndroid Build Coastguard Worker  if(curl) {
65*6236dae4SAndroid Build Coastguard Worker    CURLcode res;
66*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
67*6236dae4SAndroid Build Coastguard Worker
68*6236dae4SAndroid Build Coastguard Worker    /* of all addresses example.com resolves to, only IPv6 ones are used */
69*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V6);
70*6236dae4SAndroid Build Coastguard Worker
71*6236dae4SAndroid Build Coastguard Worker    res = curl_easy_perform(curl);
72*6236dae4SAndroid Build Coastguard Worker
73*6236dae4SAndroid Build Coastguard Worker    curl_easy_cleanup(curl);
74*6236dae4SAndroid Build Coastguard Worker  }
75*6236dae4SAndroid Build Coastguard Worker}
76*6236dae4SAndroid Build Coastguard Worker~~~
77*6236dae4SAndroid Build Coastguard Worker
78*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
79*6236dae4SAndroid Build Coastguard Worker
80*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
81*6236dae4SAndroid Build Coastguard Worker
82*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK
83