summaryrefslogtreecommitdiff
path: root/ares_library_cleanup.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2009-05-23 20:23:44 (GMT)
committerDaniel Stenberg <daniel@haxx.se>2009-05-23 20:23:44 (GMT)
commit179a0d2b288e1a1633e5802f696936dc1c60a06d (patch)
treef758f3701d8bdae918a3411e917c3ec28e333462 /ares_library_cleanup.3
parent66a7fb1605fa96c7a8bb5a3db6e6144e4795d516 (diff)
downloadc-ares-179a0d2b288e1a1633e5802f696936dc1c60a06d.zip
c-ares-179a0d2b288e1a1633e5802f696936dc1c60a06d.tar.gz
c-ares-179a0d2b288e1a1633e5802f696936dc1c60a06d.tar.bz2
minor edits
Diffstat (limited to 'ares_library_cleanup.3')
-rw-r--r--ares_library_cleanup.331
1 files changed, 15 insertions, 16 deletions
diff --git a/ares_library_cleanup.3 b/ares_library_cleanup.3
index 3cd9de9..5665c57 100644
--- a/ares_library_cleanup.3
+++ b/ares_library_cleanup.3
@@ -36,33 +36,32 @@ was initialized.
.PP
This function must be called when the program using c-ares will
no longer need any c-ares function. Once the program has called
-ares_library_cleanup() it shall not make any further call to any
+\fIares_library_cleanup(3)\fP it shall not make any further call to any
c-ares function.
.PP
This function does not cancel any pending c-ares lookups or requests
previously done. Program must use \fIares_cancel(3)\fP for this purpose.
.PP
.B This function is not thread safe.
-You have to call it once the program
-is about to terminate, but this call must be done once the program has
-terminated every single thread that it could have initiated. This is
-required to avoid potential race conditions in library deinitialization,
-and also due to the fact that ares_library_cleanup() might call functions
-from other libraries that are thread unsafe, and could conflict with any
-other thread that is already using these other libraries.
+You have to call it once the program is about to terminate, but this call must
+be done once the program has terminated every single thread that it could have
+initiated. This is required to avoid potential race conditions in library
+deinitialization, and also due to the fact that \fIares_library_cleanup(3)\fP
+might call functions from other libraries that are thread unsafe, and could
+conflict with any other thread that is already using these other libraries.
.PP
-Win32/64 application DLLs shall not call ares_library_cleanup() from the
-DllMain function. Doing so will produce deadlocks and other problems.
+Win32/64 application DLLs shall not call \fIares_library_cleanup(3)\fP from
+the DllMain function. Doing so will produce deadlocks and other problems.
.SH NOTES
-This function was first introduced in c-ares version 1.6.1 along with
-the definition of preprocessor symbol \fICARES_HAVE_ARES_LIBRARY_CLEANUP\fP
-as an indication of the availability of this function.
+This function was first introduced in c-ares version 1.6.1 along with the
+definition of preprocessor symbol \fICARES_HAVE_ARES_LIBRARY_CLEANUP\fP as an
+indication of the availability of this function.
.PP
-Since the introduction of this function, it is absolutely mandatory to
-call it for any Win32/64 program using c-ares.
+Since the introduction of this function, it is absolutely mandatory to call it
+for any Win32/64 program using c-ares.
.PP
Non-Win32/64 systems can still use c-ares version 1.6.1 without calling
-ares_library_cleanup() due to the fact that it is nearly a do-nothing
+\fIares_library_cleanup(3)\fP due to the fact that it is nearly a do-nothing
function on non-Win32/64 platforms.
.SH SEE ALSO
.BR ares_library_init(3),