CURLOPT_FORBID_REUSE.3 2.3 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_FORBID_REUSE 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_setopt options"
  26. .SH NAME
  27. CURLOPT_FORBID_REUSE \- make connection get closed at once after use
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FORBID_REUSE, long close);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a long. Set \fIclose\fP to 1 to make libcurl explicitly close the
  35. connection when done with the transfer. Normally, libcurl keeps all
  36. connections alive when done with one transfer in case a succeeding one follows
  37. that can re-use them. This option should be used with caution and only if you
  38. understand what it does as it can seriously impact performance.
  39. Set to 0 to have libcurl keep the connection open for possible later re-use
  40. (default behavior).
  41. .SH DEFAULT
  42. 0
  43. .SH PROTOCOLS
  44. Most
  45. .SH EXAMPLE
  46. .nf
  47. {
  48. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  49. curl_easy_setopt(curl, CURLOPT_FORBID_REUSE, 1L);
  50. curl_easy_perform(curl);
  51. /* this second transfer may not reuse the same connection */
  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_FRESH_CONNECT "(3), " CURLOPT_MAXCONNECTS "(3), "
  61. .BR CURLOPT_MAXLIFETIME_CONN "(3), "