diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2012-12-11 23:31:45 +0100 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2012-12-11 23:31:45 +0100 |
| commit | 50d7397ea54df79e403649d1e37d002eb52d268f (patch) | |
| tree | 6b6eed95d3d4b69cd26e0b2377fa934d5ea99c09 /docs/libcurl/curl_multi_cleanup.3 | |
| parent | a3d6368c690b943e92082951e8c5fc3ef2d76c12 (diff) | |
| parent | 4deb52831a071bc83cefb4871764281a5c32f902 (diff) | |
| download | curl-multi-always.tar.gz | |
Merge branch 'multi2' into multi-alwaysmulti-always
Diffstat (limited to 'docs/libcurl/curl_multi_cleanup.3')
| -rw-r--r-- | docs/libcurl/curl_multi_cleanup.3 | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/libcurl/curl_multi_cleanup.3 b/docs/libcurl/curl_multi_cleanup.3 new file mode 100644 index 000000000..e83c9f01b --- /dev/null +++ b/docs/libcurl/curl_multi_cleanup.3 @@ -0,0 +1,46 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at http://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.TH curl_multi_cleanup 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual" +.SH NAME +curl_multi_cleanup - close down a multi session +.SH SYNOPSIS +.B #include <curl/curl.h> +.sp +.BI "CURLMcode curl_multi_cleanup( CURLM *multi_handle );" +.ad +.SH 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 \fIcurl_easy_cleanup(3)\fP way. The order of +cleaning up should be: + +1 - \fIcurl_multi_remove_handle(3)\fP before any easy handles are cleaned up + +2 - \fIcurl_easy_cleanup(3)\fP can now be called independently since the easy +handle is no longer connected to the multi handle + +3 - \fIcurl_multi_cleanup(3)\fP should be called when all easy handles are +removed +.SH RETURN VALUE +CURLMcode type, general libcurl multi interface error code. +.SH "SEE ALSO" +.BR curl_multi_init "(3)," curl_easy_cleanup "(3)," curl_easy_init "(3)" |