CURLOPT_FRESH_CONNECT.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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_FRESH_CONNECT 3 "17 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_FRESH_CONNECT \- force a new connection to be used
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FRESH_CONNECT, long fresh);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a long. Set to 1 to make the next transfer use a new (fresh) connection
  35. by force instead of trying to re-use an existing one. This option should be
  36. used with caution and only if you understand what it does as it may seriously
  37. impact performance.
  38. Related functionality is \fICURLOPT_FORBID_REUSE(3)\fP which makes sure the
  39. connection is closed after use so that it will not be re-used.
  40. Set \fIfresh\fP to 0 to have libcurl attempt re-using an existing connection
  41. (default behavior).
  42. .SH DEFAULT
  43. 0
  44. .SH PROTOCOLS
  45. Most
  46. .SH EXAMPLE
  47. .nf
  48. {
  49. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  50. curl_easy_setopt(curl, CURLOPT_FRESH_CONNECT, 1L);
  51. /* this transfer must use a new connection, not reuse an existing */
  52. curl_easy_perform(curl);
  53. }
  54. .fi
  55. .SH AVAILABILITY
  56. Always
  57. .SH RETURN VALUE
  58. Returns CURLE_OK
  59. .SH "SEE ALSO"
  60. .BR CURLOPT_FORBID_REUSE "(3), "