| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, 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_RESOLVE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_RESOLVE \- provide custom host name to IP address resolves |
| 26 |
.SH SYNOPSIS |
| 27 |
.nf |
| 28 |
#include <curl/curl.h> |
| 29 |
|
| 30 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESOLVE, |
| 31 |
struct curl_slist *hosts); |
| 32 |
.SH DESCRIPTION |
| 33 |
Pass a pointer to a linked list of strings with host name resolve information |
| 34 |
to use for requests with this handle. The linked list should be a fully valid |
| 35 |
list of \fBstruct curl_slist\fP structs properly filled in. Use |
| 36 |
\fIcurl_slist_append(3)\fP to create the list and \fIcurl_slist_free_all(3)\fP |
| 37 |
to clean up an entire list. |
| 38 |
|
| 39 |
Each single name resolve string should be written using the format |
| 40 |
HOST:PORT:ADDRESS[,ADDRESS]... where HOST is the name libcurl will try |
| 41 |
to resolve, PORT is the port number of the service where libcurl wants |
| 42 |
to connect to the HOST and ADDRESS is one or more numerical IP |
| 43 |
addresses. If you specify multiple ip addresses they need to be |
| 44 |
separated by comma. If libcurl is built to support IPv6, each of the |
| 45 |
ADDRESS entries can of course be either IPv4 or IPv6 style addressing. |
| 46 |
|
| 47 |
This option effectively pre-populates the DNS cache with entries for the |
| 48 |
host+port pair so redirects and everything that operations against the |
| 49 |
HOST+PORT will instead use your provided ADDRESS. Addresses set with |
| 50 |
\fICURLOPT_RESOLVE(3)\fP will not time-out from the DNS cache like ordinary |
| 51 |
entries. |
| 52 |
|
| 53 |
If the DNS cache already have an entry for the given host+port pair, then |
| 54 |
this entry will be removed and a new entry will be created. This is because |
| 55 |
old entry may have have different addresses or be ordinary entries with |
| 56 |
time-outs. |
| 57 |
|
| 58 |
The provided ADDRESS set by this option will be used even if |
| 59 |
\fICURLOPT_IPRESOLVE(3)\fP is set to make libcurl use another IP version. |
| 60 |
|
| 61 |
Remove names from the DNS cache again, to stop providing these fake resolves, |
| 62 |
by including a string in the linked list that uses the format |
| 63 |
\&"-HOST:PORT". The host name must be prefixed with a dash, and the host name |
| 64 |
and port number must exactly match what was already added previously. |
| 65 |
|
| 66 |
Support for providing the ADDRESS within [brackets] was added in 7.57.0. |
| 67 |
|
| 68 |
Support for providing multiple IP addresses per entry was added in 7.59.0. |
| 69 |
.SH DEFAULT |
| 70 |
NULL |
| 71 |
.SH PROTOCOLS |
| 72 |
All |
| 73 |
.SH EXAMPLE |
| 74 |
.nf |
| 75 |
CURL *curl; |
| 76 |
struct curl_slist *host = NULL; |
| 77 |
host = curl_slist_append(NULL, "example.com:80:127.0.0.1"); |
| 78 |
|
| 79 |
curl = curl_easy_init(); |
| 80 |
if(curl) { |
| 81 |
curl_easy_setopt(curl, CURLOPT_RESOLVE, host); |
| 82 |
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); |
| 83 |
|
| 84 |
curl_easy_perform(curl); |
| 85 |
|
| 86 |
/* always cleanup */ |
| 87 |
curl_easy_cleanup(curl); |
| 88 |
} |
| 89 |
|
| 90 |
curl_slist_free_all(host); |
| 91 |
.fi |
| 92 |
.SH AVAILABILITY |
| 93 |
Added in 7.21.3. Removal support added in 7.42.0. |
| 94 |
.SH RETURN VALUE |
| 95 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 96 |
.SH "SEE ALSO" |
| 97 |
.BR CURLOPT_IPRESOLVE "(3), " CURLOPT_DNS_CACHE_TIMEOUT "(3), " CURLOPT_CONNECT_TO "(3), " |