CURLOPT_LOCALPORT.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2017, 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.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_LOCALPORT 3 "May 31, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_LOCALPORT \- set local port number to use for socket
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOCALPORT, long port);
  29. .SH DESCRIPTION
  30. Pass a long. This sets the local port number of the socket used for the
  31. connection. This can be used in combination with \fICURLOPT_INTERFACE(3)\fP
  32. and you are recommended to use \fICURLOPT_LOCALPORTRANGE(3)\fP as well when
  33. this option is set. Valid port numbers are 1 - 65535.
  34. .SH DEFAULT
  35. 0, disabled - use whatever the system thinks is fine
  36. .SH PROTOCOLS
  37. All
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
  43. curl_easy_setopt(curl, CURLOPT_LOCALPORT, 8080L);
  44. /* and try 20 more ports following that */
  45. curl_easy_setopt(curl, CURLOPT_LOCALPORTRANGE, 20L);
  46. ret = curl_easy_perform(curl);
  47. curl_easy_cleanup(curl);
  48. }
  49. .fi
  50. .SH AVAILABILITY
  51. Added in 7.15.2
  52. .SH RETURN VALUE
  53. Returns CURLE_OK
  54. .SH "SEE ALSO"
  55. .BR CURLOPT_LOCALPORTRANGE "(3), " CURLOPT_INTERFACE "(3), "