eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
66 lines
1.4 KiB
Markdown
66 lines
1.4 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_multi_cleanup
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- curl_easy_cleanup (3)
|
|
- curl_easy_init (3)
|
|
- curl_multi_get_handles (3)
|
|
- curl_multi_init (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_multi_cleanup - close down a multi session
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLMcode curl_multi_cleanup(CURLM *multi_handle);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Cleans up and removes a whole multi stack. It does not free or touch any
|
|
individual easy handles in any way - they still need to be closed
|
|
individually, using the usual curl_easy_cleanup(3) way. The order of
|
|
cleaning up should be:
|
|
|
|
1 - curl_multi_remove_handle(3) before any easy handles are cleaned up
|
|
|
|
2 - curl_easy_cleanup(3) can now be called independently since the easy
|
|
handle is no longer connected to the multi handle
|
|
|
|
3 - curl_multi_cleanup(3) should be called when all easy handles are
|
|
removed
|
|
|
|
Passing in a NULL pointer in *multi_handle* makes this function return
|
|
CURLM_BAD_HANDLE immediately with no other action.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURLM *multi = curl_multi_init();
|
|
|
|
/* when the multi transfer is done ... */
|
|
|
|
/* remove all easy handles, then: */
|
|
curl_multi_cleanup(multi);
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.9.6
|
|
|
|
# RETURN VALUE
|
|
|
|
CURLMcode type, general libcurl multi interface error code. On success,
|
|
CURLM_OK is returned.
|