aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_global_cleanup.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2006-01-15 23:55:53 +0000
committerDaniel Stenberg <daniel@haxx.se>2006-01-15 23:55:53 +0000
commit4c35a40858db71daa0f6be4111c620fb201f245a (patch)
tree1107ae836fbf51f066d45363103b278de81c8636 /docs/libcurl/curl_global_cleanup.3
parent802b2aaf6a5e640b868dc47b53df13a7d931cc5e (diff)
Bryan Henderson turned the 'initialized' variable for curl_global_init()
into a counter, and thus you can now do multiple curl_global_init() and you are then supposed to do the same amount of calls to curl_global_cleanup(). Bryan also updated the docs accordingly.
Diffstat (limited to 'docs/libcurl/curl_global_cleanup.3')
-rw-r--r--docs/libcurl/curl_global_cleanup.319
1 files changed, 14 insertions, 5 deletions
diff --git a/docs/libcurl/curl_global_cleanup.3 b/docs/libcurl/curl_global_cleanup.3
index 566b110e0..3c7724d34 100644
--- a/docs/libcurl/curl_global_cleanup.3
+++ b/docs/libcurl/curl_global_cleanup.3
@@ -11,13 +11,22 @@ curl_global_cleanup - global libcurl cleanup
.BI "void curl_global_cleanup(void);"
.ad
.SH DESCRIPTION
-curl_global_cleanup must be called once (no matter how many threads or libcurl
-sessions that'll be used) by every application that uses libcurl, after all
-uses of libcurl is complete.
+This function releases resources acquired by \fBcurl_global_init\fP.
-This is the opposite of \fIcurl_global_init(3)\fP.
+You should call \fIcurl_global_cleanup()\fP once for each call you make
+to \fIcurl_global_init\fP, after you are done using libcurl.
+
+\fBThis function is not thread safe.\fP You must not call it when any
+other thread in the program (i.e. a thread sharing the same memory) is
+running. This doesn't just mean no other thread that is using
+libcurl. Because \fBcurl_global_cleanup()\fP calls functions of other
+libraries that are similarly thread unsafe, it could conflict with any
+other thread that uses these other libraries.
+
+See the description in \fBlibcurl\fP(3) of global environment
+requirements for details of how to use this function.
-Not calling this function may result in memory leaks.
.SH "SEE ALSO"
.BR curl_global_init "(3), "
+.BR libcurl "(3), "