Annotation of embedaddon/curl/docs/libcurl/curl_global_cleanup.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2016, 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_global_cleanup 3 "September 20, 2016" "libcurl 7.70.0" "libcurl Manual"
! 23:
! 24: .SH NAME
! 25: curl_global_cleanup - global libcurl cleanup
! 26: .SH SYNOPSIS
! 27: .B #include <curl/curl.h>
! 28: .sp
! 29: .BI "void curl_global_cleanup(void);"
! 30: .ad
! 31: .SH DESCRIPTION
! 32: This function releases resources acquired by \fIcurl_global_init(3)\fP.
! 33:
! 34: You should call \fIcurl_global_cleanup(3)\fP once for each call you make to
! 35: \fIcurl_global_init(3)\fP, after you are done using libcurl.
! 36:
! 37: \fBThis function is not thread safe.\fP You must not call it when any other
! 38: thread in the program (i.e. a thread sharing the same memory) is running.
! 39: This doesn't just mean no other thread that is using libcurl. Because
! 40: \fIcurl_global_cleanup(3)\fP calls functions of other libraries that are
! 41: similarly thread unsafe, it could conflict with any other thread that uses
! 42: these other libraries.
! 43:
! 44: See the description in \fIlibcurl(3)\fP of global environment requirements for
! 45: details of how to use this function.
! 46: .SH CAUTION
! 47: \fIcurl_global_cleanup(3)\fP does not block waiting for any libcurl-created
! 48: threads to terminate (such as threads used for name resolving). If a module
! 49: containing libcurl is dynamically unloaded while libcurl-created threads are
! 50: still running then your program may crash or other corruption may occur. We
! 51: recommend you do not run libcurl from any module that may be unloaded
! 52: dynamically. This behavior may be addressed in the future.
! 53: .SH "SEE ALSO"
! 54: .BR curl_global_init "(3), "
! 55: .BR libcurl "(3), "
! 56: .BR libcurl-thread "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>