xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_PREREQDATA.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_PREREQDATA
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - CURLINFO_PRIMARY_IP (3)
9*6236dae4SAndroid Build Coastguard Worker  - CURLINFO_PRIMARY_PORT (3)
10*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_PREREQFUNCTION (3)
11*6236dae4SAndroid Build Coastguard WorkerProtocol:
12*6236dae4SAndroid Build Coastguard Worker  - All
13*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.80.0
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_PREREQDATA - pointer passed to the pre-request callback
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_PREREQDATA, void *pointer);
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 WorkerPass a *pointer* that is untouched by libcurl and passed as the first
31*6236dae4SAndroid Build Coastguard Workerargument in the pre-request callback set with CURLOPT_PREREQFUNCTION(3).
32*6236dae4SAndroid Build Coastguard Worker
33*6236dae4SAndroid Build Coastguard Worker# DEFAULT
34*6236dae4SAndroid Build Coastguard Worker
35*6236dae4SAndroid Build Coastguard WorkerNULL
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
38*6236dae4SAndroid Build Coastguard Worker
39*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
40*6236dae4SAndroid Build Coastguard Worker
41*6236dae4SAndroid Build Coastguard Worker~~~c
42*6236dae4SAndroid Build Coastguard Workerstruct priv {
43*6236dae4SAndroid Build Coastguard Worker  void *custom;
44*6236dae4SAndroid Build Coastguard Worker};
45*6236dae4SAndroid Build Coastguard Worker
46*6236dae4SAndroid Build Coastguard Workerstatic int prereq_callback(void *clientp,
47*6236dae4SAndroid Build Coastguard Worker                           char *conn_primary_ip,
48*6236dae4SAndroid Build Coastguard Worker                           char *conn_local_ip,
49*6236dae4SAndroid Build Coastguard Worker                           int conn_primary_port,
50*6236dae4SAndroid Build Coastguard Worker                           int conn_local_port)
51*6236dae4SAndroid Build Coastguard Worker{
52*6236dae4SAndroid Build Coastguard Worker  printf("Connection made to %s:%d\n", conn_primary_ip, conn_primary_port);
53*6236dae4SAndroid Build Coastguard Worker  return CURL_PREREQFUNC_OK;
54*6236dae4SAndroid Build Coastguard Worker}
55*6236dae4SAndroid Build Coastguard Worker
56*6236dae4SAndroid Build Coastguard Workerint main(void)
57*6236dae4SAndroid Build Coastguard Worker{
58*6236dae4SAndroid Build Coastguard Worker  struct priv prereq_data;
59*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
60*6236dae4SAndroid Build Coastguard Worker  if(curl) {
61*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_PREREQFUNCTION, prereq_callback);
62*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_PREREQDATA, &prereq_data);
63*6236dae4SAndroid Build Coastguard Worker    curl_easy_perform(curl);
64*6236dae4SAndroid Build Coastguard Worker  }
65*6236dae4SAndroid Build Coastguard Worker}
66*6236dae4SAndroid Build Coastguard Worker~~~
67*6236dae4SAndroid Build Coastguard Worker
68*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
69*6236dae4SAndroid Build Coastguard Worker
70*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
71*6236dae4SAndroid Build Coastguard Worker
72*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
73