xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_PROXYPORT.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_PROXYPORT
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_PORT (3)
9*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_PORT (3)
10*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_PROXY (3)
11*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_PROXYTYPE (3)
12*6236dae4SAndroid Build Coastguard WorkerProtocol:
13*6236dae4SAndroid Build Coastguard Worker  - All
14*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.1
15*6236dae4SAndroid Build Coastguard Worker---
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard Worker# NAME
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard WorkerCURLOPT_PROXYPORT - port number the proxy listens on
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
22*6236dae4SAndroid Build Coastguard Worker
23*6236dae4SAndroid Build Coastguard Worker~~~c
24*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
25*6236dae4SAndroid Build Coastguard Worker
26*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port);
27*6236dae4SAndroid Build Coastguard Worker~~~
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
30*6236dae4SAndroid Build Coastguard Worker
31*6236dae4SAndroid Build Coastguard WorkerWe discourage use of this option.
32*6236dae4SAndroid Build Coastguard Worker
33*6236dae4SAndroid Build Coastguard WorkerPass a long with this option to set the proxy port to connect to unless it is
34*6236dae4SAndroid Build Coastguard Workerspecified in the proxy string CURLOPT_PROXY(3) or uses 443 for https proxies
35*6236dae4SAndroid Build Coastguard Workerand 1080 for all others as default.
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard WorkerDisabling this option, setting it to zero, makes it not specified which makes
38*6236dae4SAndroid Build Coastguard Workerlibcurl use the default proxy port number or the port number specified in the
39*6236dae4SAndroid Build Coastguard Workerproxy URL string.
40*6236dae4SAndroid Build Coastguard Worker
41*6236dae4SAndroid Build Coastguard WorkerWhile this accepts a 'long', the port number is 16 bit so it cannot be larger
42*6236dae4SAndroid Build Coastguard Workerthan 65535.
43*6236dae4SAndroid Build Coastguard Worker
44*6236dae4SAndroid Build Coastguard Worker# DEFAULT
45*6236dae4SAndroid Build Coastguard Worker
46*6236dae4SAndroid Build Coastguard Worker0
47*6236dae4SAndroid Build Coastguard Worker
48*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
49*6236dae4SAndroid Build Coastguard Worker
50*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
51*6236dae4SAndroid Build Coastguard Worker
52*6236dae4SAndroid Build Coastguard Worker~~~c
53*6236dae4SAndroid Build Coastguard Workerint main(void)
54*6236dae4SAndroid Build Coastguard Worker{
55*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
56*6236dae4SAndroid Build Coastguard Worker  if(curl) {
57*6236dae4SAndroid Build Coastguard Worker    CURLcode res;
58*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
59*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_PROXY, "localhost");
60*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_PROXYPORT, 8080L);
61*6236dae4SAndroid Build Coastguard Worker    res = curl_easy_perform(curl);
62*6236dae4SAndroid Build Coastguard Worker    curl_easy_cleanup(curl);
63*6236dae4SAndroid Build Coastguard Worker  }
64*6236dae4SAndroid Build Coastguard Worker}
65*6236dae4SAndroid Build Coastguard Worker~~~
66*6236dae4SAndroid Build Coastguard Worker
67*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
68*6236dae4SAndroid Build Coastguard Worker
69*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
70*6236dae4SAndroid Build Coastguard Worker
71*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK
72