CURLOPT_LOCALPORTRANGE.3 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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 https://curl.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLOPT_LOCALPORTRANGE 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_setopt options"
  26. .SH NAME
  27. CURLOPT_LOCALPORTRANGE \- number of additional local ports to try
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOCALPORTRANGE,
  32. long range);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a long. The \fIrange\fP argument is the number of attempts libcurl will
  36. make to find a working local port number. It starts with the given
  37. \fICURLOPT_LOCALPORT(3)\fP and adds one to the number for each retry. Setting
  38. this option to 1 or below will make libcurl do only one try for the exact port
  39. number. Port numbers by nature are scarce resources that will be busy at times
  40. so setting this value to something too low might cause unnecessary connection
  41. setup failures.
  42. .SH DEFAULT
  43. 1
  44. .SH PROTOCOLS
  45. All
  46. .SH EXAMPLE
  47. .nf
  48. CURL *curl = curl_easy_init();
  49. if(curl) {
  50. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
  51. curl_easy_setopt(curl, CURLOPT_LOCALPORT, 49152L);
  52. /* and try 20 more ports following that */
  53. curl_easy_setopt(curl, CURLOPT_LOCALPORTRANGE, 20L);
  54. ret = curl_easy_perform(curl);
  55. curl_easy_cleanup(curl);
  56. }
  57. .fi
  58. .SH AVAILABILITY
  59. Added in 7.15.2
  60. .SH RETURN VALUE
  61. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62. .SH "SEE ALSO"
  63. .BR CURLOPT_LOCALPORT "(3), " CURLOPT_INTERFACE "(3), "