Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLOPT_RESOLVER_START_FUNCTION.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2018, 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_RESOLVER_START_FUNCTION 3 "14 Feb 2018" "libcurl 7.59.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_RESOLVER_START_FUNCTION \- set callback to be called before a new resolve request is started
26 .SH SYNOPSIS
27 .nf
28 #include <curl/curl.h>
29
30 int resolver_start_cb(void *resolver_state, void *reserved, void *userdata);
31
32 CURLcode curl_easy_setopt(CURL *handle,
33 CURLOPT_RESOLVER_START_FUNCTION,
34 resolver_start_cb);
35 .SH DESCRIPTION
36 Pass a pointer to your callback function, which should match the prototype
37 shown above.
38
39 This callback function gets called by libcurl every time before a new resolve
40 request is started.
41
42 \fIresolver_state\fP points to a backend-specific resolver state. Currently
43 only the ares resolver backend has a resolver state. It can be used to set up
44 any desired option on the ares channel before it's used, for example setting up
45 socket callback options.
46
47 \fIreserved\fP is reserved.
48
49 \fIuserdata\fP is the user pointer set with the
50 \fICURLOPT_RESOLVER_START_DATA(3)\fP option.
51
52 The callback must return 0 on success. Returning a non-zero value will cause
53 the resolve to fail.
54 .SH DEFAULT
55 NULL (No callback)
56 .SH PROTOCOLS
57 All
58 .SH EXAMPLE
59 .nf
60 static int resolver_start_cb(void *resolver_state, void *reserved,
61 void *userdata)
62 {
63 (void)reserved;
64 printf("Received resolver_state=%p userdata=%p\\n",
65 resolver_state, userdata);
66 return 0;
67 }
68
69 CURL *curl = curl_easy_init();
70 if(curl) {
71 curl_easy_setopt(curl, CURLOPT_RESOLVER_START_FUNCTION, resolver_start_cb);
72 curl_easy_setopt(curl, CURLOPT_RESOLVER_START_DATA, curl);
73 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
74 curl_easy_perform(curl);
75 curl_easy_cleanup(curl);
76 }
77 .fi
78 .SH AVAILABILITY
79 Added in 7.59.0
80 .SH RETURN VALUE
81 Returns CURLE_OK
82 .SH "SEE ALSO"
83 .BR CURLOPT_RESOLVER_START_DATA "(3) "