CURLOPT_QUICK_EXIT.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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_QUICK_EXIT 3 "30 Sep 2022" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_QUICK_EXIT \- allow to exit quickly
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_QUICK_EXIT,
  32. long value);
  33. .SH DESCRIPTION
  34. Pass a long as a parameter, 1L meaning that when recovering from a timeout,
  35. libcurl should skip lengthy cleanups that are intended to avoid all kinds of
  36. leaks (threads etc.), as the caller program is about to call exit() anyway.
  37. This allows for a swift termination after a DNS timeout for example, by
  38. canceling and/or forgetting about a resolver thread, at the expense of a
  39. possible (though short-lived) leak of associated resources.
  40. .SH DEFAULT
  41. 0
  42. .SH PROTOCOLS
  43. All
  44. .SH EXAMPLE
  45. .nf
  46. CURL *curl = curl_easy_init();
  47. if(curl) {
  48. CURLcode ret;
  49. curl_easy_setopt(curl, CURLOPT_QUICK_EXIT, 1L);
  50. ret = curl_easy_perform(curl);
  51. }
  52. .fi
  53. .SH AVAILABILITY
  54. Added in 7.87.0
  55. .SH RETURN VALUE
  56. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  57. .SH "SEE ALSO"
  58. .BR CURLOPT_RESOLVE "(3), "