CURLOPT_FORBID_REUSE.3 2.2 KB

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