xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_LOCALPORTRANGE.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_LOCALPORTRANGE
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_INTERFACE (3)
9*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_LOCALPORT (3)
10*6236dae4SAndroid Build Coastguard WorkerProtocol:
11*6236dae4SAndroid Build Coastguard Worker  - All
12*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.15.2
13*6236dae4SAndroid Build Coastguard Worker---
14*6236dae4SAndroid Build Coastguard Worker
15*6236dae4SAndroid Build Coastguard Worker# NAME
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard WorkerCURLOPT_LOCALPORTRANGE - number of additional local ports to try
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker~~~c
22*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
23*6236dae4SAndroid Build Coastguard Worker
24*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOCALPORTRANGE,
25*6236dae4SAndroid Build Coastguard Worker                          long range);
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 long. The *range* argument is the number of attempts libcurl makes
31*6236dae4SAndroid Build Coastguard Workerto find a working local port number. It starts with the given
32*6236dae4SAndroid Build Coastguard WorkerCURLOPT_LOCALPORT(3) and adds one to the number for each retry. Setting
33*6236dae4SAndroid Build Coastguard Workerthis option to 1 or below makes libcurl only do one try for the exact port
34*6236dae4SAndroid Build Coastguard Workernumber. Port numbers by nature are scarce resources that are busy at times so
35*6236dae4SAndroid Build Coastguard Workersetting this value to something too low might cause unnecessary connection
36*6236dae4SAndroid Build Coastguard Workersetup failures.
37*6236dae4SAndroid Build Coastguard Worker
38*6236dae4SAndroid Build Coastguard Worker# DEFAULT
39*6236dae4SAndroid Build Coastguard Worker
40*6236dae4SAndroid Build Coastguard Worker1
41*6236dae4SAndroid Build Coastguard Worker
42*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
43*6236dae4SAndroid Build Coastguard Worker
44*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
45*6236dae4SAndroid Build Coastguard Worker
46*6236dae4SAndroid Build Coastguard Worker~~~c
47*6236dae4SAndroid Build Coastguard Workerint main(void)
48*6236dae4SAndroid Build Coastguard Worker{
49*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
50*6236dae4SAndroid Build Coastguard Worker  if(curl) {
51*6236dae4SAndroid Build Coastguard Worker    CURLcode res;
52*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
53*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_LOCALPORT, 49152L);
54*6236dae4SAndroid Build Coastguard Worker    /* and try 20 more ports following that */
55*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_LOCALPORTRANGE, 20L);
56*6236dae4SAndroid Build Coastguard Worker    res = curl_easy_perform(curl);
57*6236dae4SAndroid Build Coastguard Worker    curl_easy_cleanup(curl);
58*6236dae4SAndroid Build Coastguard Worker  }
59*6236dae4SAndroid Build Coastguard Worker}
60*6236dae4SAndroid Build Coastguard Worker~~~
61*6236dae4SAndroid Build Coastguard Worker
62*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
63*6236dae4SAndroid Build Coastguard Worker
64*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
65*6236dae4SAndroid Build Coastguard Worker
66*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
67