Return to curl_multi_cleanup.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl

Annotation of embedaddon/curl/docs/libcurl/curl_multi_cleanup.3, revision 1.1

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