Blame view

3rdparty/curl/share/man/man3/CURLOPT_RESOLVE.3 4.12 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
  .\" *
  .\" * This software is licensed as described in the file COPYING, which
  .\" * you should have received as part of this distribution. The terms
  .\" * are also available at https://curl.se/docs/copyright.html.
  .\" *
  .\" * 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_RESOLVE 3 "April 24, 2021" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_RESOLVE \- provide custom host name to IP address resolves
  .SH SYNOPSIS
  .nf
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESOLVE,
                            struct curl_slist *hosts);
  .SH DESCRIPTION
  Pass a pointer to a linked list of strings with host name resolve information
  to use for requests with this handle. The linked list should be a fully valid
  list of \fBstruct curl_slist\fP structs properly filled in. Use
  \fIcurl_slist_append(3)\fP to create the list and \fIcurl_slist_free_all(3)\fP
  to clean up an entire list.
  
  Each single name resolve string should be written using the format
  [+]HOST:PORT:ADDRESS[,ADDRESS]... where HOST is the name libcurl will try
  to resolve, PORT is the port number of the service where libcurl wants
  to connect to the HOST and ADDRESS is one or more numerical IP
  addresses. If you specify multiple ip addresses they need to be
  separated by comma. If libcurl is built to support IPv6, each of the
  ADDRESS entries can of course be either IPv4 or IPv6 style addressing.
  
  This option effectively pre-populates the DNS cache with entries for the
  host+port pair so redirects and everything that operations against the
  HOST+PORT will instead use your provided ADDRESS.
  
  The optional leading "+" signifies whether the new entry should time-out or
  not. Entries added with "HOST:..." will never time-out whereas entries added
  with "+HOST:..." will time-out just like ordinary DNS cache entries.
  
  If the DNS cache already has an entry for the given host+port pair, then
  this entry will be removed and a new entry will be created. This is because
  the old entry may have have different addresses or a different time-out
  setting.
  
  An ADDRESS provided by this option will only be use if not restricted by
  the setting of \fICURLOPT_IPRESOLVE(3)\fP to a different IP version.
  
  Remove names from the DNS cache again, to stop providing these fake resolves,
  by including a string in the linked list that uses the format
  \&"-HOST:PORT". The host name must be prefixed with a dash, and the host name
  and port number must exactly match what was already added previously.
  
  Support for providing the ADDRESS within [brackets] was added in 7.57.0.
  
  Support for providing multiple IP addresses per entry was added in 7.59.0.
  
  Support for adding non-permanent entries by using the "+" prefix was added in
  7.75.0.
  .SH DEFAULT
  NULL
  .SH PROTOCOLS
  All
  .SH EXAMPLE
  .nf
  CURL *curl;
  struct curl_slist *host = NULL;
  host = curl_slist_append(NULL, "example.com:80:127.0.0.1");
  
  curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_RESOLVE, host);
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  
    curl_easy_perform(curl);
  
    /* always cleanup */
    curl_easy_cleanup(curl);
  }
  
  curl_slist_free_all(host);
  .fi
  .SH AVAILABILITY
  Added in 7.21.3. Removal support added in 7.42.0.
  .SH RETURN VALUE
  Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  .SH "SEE ALSO"
  .BR CURLOPT_IPRESOLVE "(3), " CURLOPT_DNS_CACHE_TIMEOUT "(3), " CURLOPT_CONNECT_TO "(3), "