tizen 2.3.1 release
[external/curl.git] / docs / libcurl / opts / CURLOPT_LOCALPORTRANGE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, 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 http://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_LOCALPORTRANGE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_LOCALPORTRANGE \- number of additional local ports to try
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOCALPORTRANGE,
30                           long range);
31 .SH DESCRIPTION
32 Pass a long. The \fIrange\fP argument is the number of attempts libcurl will
33 make to find a working local port number. It starts with the given
34 \fICURLOPT_LOCALPORT(3)\fP and adds one to the number for each retry. Setting
35 this option to 1 or below will make libcurl do only one try for the exact port
36 number. Port numbers by nature are scarce resources that will be busy at times
37 so setting this value to something too low might cause unnecessary connection
38 setup failures.
39 .SH DEFAULT
40 1
41 .SH PROTOCOLS
42 All
43 .SH EXAMPLE
44 TODO
45 .SH AVAILABILITY
46 Added in 7.15.2
47 .SH RETURN VALUE
48 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
49 .SH "SEE ALSO"
50 .BR CURLOPT_LOCALPORT "(3), " CURLOPT_INTERFACE "(3), "