curl_multi_cleanup.3 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2022, 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. .TH curl_multi_cleanup 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"
  25. .SH NAME
  26. curl_multi_cleanup - close down a multi session
  27. .SH SYNOPSIS
  28. .nf
  29. #include <curl/curl.h>
  30. CURLMcode curl_multi_cleanup(CURLM *multi_handle);
  31. .fi
  32. .SH DESCRIPTION
  33. Cleans up and removes a whole multi stack. It does not free or touch any
  34. individual easy handles in any way - they still need to be closed
  35. individually, using the usual \fIcurl_easy_cleanup(3)\fP way. The order of
  36. cleaning up should be:
  37. 1 - \fIcurl_multi_remove_handle(3)\fP before any easy handles are cleaned up
  38. 2 - \fIcurl_easy_cleanup(3)\fP can now be called independently since the easy
  39. handle is no longer connected to the multi handle
  40. 3 - \fIcurl_multi_cleanup(3)\fP should be called when all easy handles are
  41. removed
  42. Passing in a NULL pointer in \fImulti_handle\fP will make this function return
  43. CURLM_BAD_HANDLE immediately with no other action.
  44. .SH EXAMPLE
  45. .nf
  46. /* when the multi transfer is done ... */
  47. /* remove all easy handles, then: */
  48. curl_multi_cleanup(multi_handle);
  49. .fi
  50. .SH AVAILABILITY
  51. Added in 7.9.6
  52. .SH RETURN VALUE
  53. CURLMcode type, general libcurl multi interface error code. On success,
  54. CURLM_OK is returned.
  55. .SH "SEE ALSO"
  56. .BR curl_multi_init "(3)," curl_easy_cleanup "(3)," curl_easy_init "(3)"