2005-09-12 13:10:09 +00:00
< html >
2022-08-24 14:34:04 +02:00
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< title > threads: interfaces for thread handling< / title >
< meta name = "generator" content = "Libxml2 devhelp stylesheet" >
< link rel = "start" href = "index.html" title = "libxml2 Reference Manual" >
< link rel = "up" href = "general.html" title = "API" >
< link rel = "stylesheet" href = "style.css" type = "text/css" >
< link rel = "chapter" href = "general.html" title = "API" >
< / head >
< body bgcolor = "white" text = "black" link = "#0000FF" vlink = "#840084" alink = "#0000FF" >
< table class = "navigation" width = "100%" summary = "Navigation header" cellpadding = "2" cellspacing = "2" > < tr valign = "middle" >
< td > < a accesskey = "p" href = "libxml2-schematron.html" > < img src = "left.png" width = "24" height = "24" border = "0" alt = "Prev" > < / a > < / td >
< td > < a accesskey = "u" href = "general.html" > < img src = "up.png" width = "24" height = "24" border = "0" alt = "Up" > < / a > < / td >
< td > < a accesskey = "h" href = "index.html" > < img src = "home.png" width = "24" height = "24" border = "0" alt = "Home" > < / a > < / td >
< td > < a accesskey = "n" href = "libxml2-tree.html" > < img src = "right.png" width = "24" height = "24" border = "0" alt = "Next" > < / a > < / td >
< th width = "100%" align = "center" > libxml2 Reference Manual< / th >
< / tr > < / table >
< h2 > < span class = "refentrytitle" > threads< / span > < / h2 >
< p > threads - interfaces for thread handling< / p >
< p > set of generic threading related routines should work with pthreads, Windows native or TLS threads < / p >
< p > Author(s): Daniel Veillard < / p >
< div class = "refsynopsisdiv" >
< h2 > Synopsis< / h2 >
< pre class = "synopsis" > typedef struct _xmlMutex < a href = "#xmlMutex" > xmlMutex< / a > ;
2022-08-19 11:28:49 +02:00
typedef < a href = "libxml2-threads.html#xmlMutex" > xmlMutex< / a > * < a href = "#xmlMutexPtr" > xmlMutexPtr< / a > ;
2005-09-12 13:10:09 +00:00
typedef struct _xmlRMutex < a href = "#xmlRMutex" > xmlRMutex< / a > ;
typedef < a href = "libxml2-threads.html#xmlRMutex" > xmlRMutex< / a > * < a href = "#xmlRMutexPtr" > xmlRMutexPtr< / a > ;
2023-11-04 19:07:37 +01:00
int < a href = "#xmlCheckThreadLocalStorage" > xmlCheckThreadLocalStorage< / a > (void);
2022-08-19 11:28:49 +02:00
void < a href = "#xmlCleanupThreads" > xmlCleanupThreads< / a > (void);
void < a href = "#xmlFreeMutex" > xmlFreeMutex< / a > (< a href = "libxml2-threads.html#xmlMutexPtr" > xmlMutexPtr< / a > tok);
2005-09-12 13:10:09 +00:00
void < a href = "#xmlFreeRMutex" > xmlFreeRMutex< / a > (< a href = "libxml2-threads.html#xmlRMutexPtr" > xmlRMutexPtr< / a > tok);
2022-08-19 11:28:49 +02:00
void < a href = "#xmlInitThreads" > xmlInitThreads< / a > (void);
2005-09-12 13:10:09 +00:00
void < a href = "#xmlLockLibrary" > xmlLockLibrary< / a > (void);
void < a href = "#xmlMutexLock" > xmlMutexLock< / a > (< a href = "libxml2-threads.html#xmlMutexPtr" > xmlMutexPtr< / a > tok);
2022-08-19 11:28:49 +02:00
void < a href = "#xmlMutexUnlock" > xmlMutexUnlock< / a > (< a href = "libxml2-threads.html#xmlMutexPtr" > xmlMutexPtr< / a > tok);
2005-09-12 13:10:09 +00:00
< a href = "libxml2-threads.html#xmlMutexPtr" > xmlMutexPtr< / a > < a href = "#xmlNewMutex" > xmlNewMutex< / a > (void);
2022-08-19 11:28:49 +02:00
< a href = "libxml2-threads.html#xmlRMutexPtr" > xmlRMutexPtr< / a > < a href = "#xmlNewRMutex" > xmlNewRMutex< / a > (void);
2007-06-12 16:20:09 +00:00
void < a href = "#xmlRMutexLock" > xmlRMutexLock< / a > (< a href = "libxml2-threads.html#xmlRMutexPtr" > xmlRMutexPtr< / a > tok);
2022-08-19 11:28:49 +02:00
void < a href = "#xmlRMutexUnlock" > xmlRMutexUnlock< / a > (< a href = "libxml2-threads.html#xmlRMutexPtr" > xmlRMutexPtr< / a > tok);
void < a href = "#xmlUnlockLibrary" > xmlUnlockLibrary< / a > (void);
2005-09-12 13:10:09 +00:00
< / pre >
2022-08-24 14:34:04 +02:00
< / div >
< div class = "refsect1" lang = "en" > < h2 > Description< / h2 > < / div >
< div class = "refsect1" lang = "en" >
< h2 > Details< / h2 >
< div class = "refsect2" lang = "en" >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlMutex" > Structure < / a > xmlMutex< / h3 >
< pre class = "programlisting" > struct _xmlMutex {
2005-09-12 13:10:09 +00:00
The content of this structure is not made public by the API.
} xmlMutex;
2022-08-24 14:34:04 +02:00
< / pre >
< p > < / p >
2005-09-12 13:10:09 +00:00
< / div >
2022-08-24 14:34:04 +02:00
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlMutexPtr" > Typedef < / a > xmlMutexPtr< / h3 >
< pre class = "programlisting" > < a href = "libxml2-threads.html#xmlMutex" > xmlMutex< / a > * xmlMutexPtr;
< / pre >
< p > < / p >
2005-09-12 13:10:09 +00:00
< / div >
2022-08-24 14:34:04 +02:00
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlRMutex" > Structure < / a > xmlRMutex< / h3 >
< pre class = "programlisting" > struct _xmlRMutex {
2005-09-12 13:10:09 +00:00
The content of this structure is not made public by the API.
} xmlRMutex;
2022-08-24 14:34:04 +02:00
< / pre >
< p > < / p >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlRMutexPtr" > Typedef < / a > xmlRMutexPtr< / h3 >
< pre class = "programlisting" > < a href = "libxml2-threads.html#xmlRMutex" > xmlRMutex< / a > * xmlRMutexPtr;
< / pre >
< p > < / p >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
2023-11-04 19:07:37 +01:00
< a name = "xmlCheckThreadLocalStorage" > < / a > xmlCheckThreadLocalStorage ()< / h3 >
< pre class = "programlisting" > int xmlCheckThreadLocalStorage (void)< br >
< / pre >
< p > Check whether thread-local storage could be allocated. In cross-platform code running in multithreaded environments, this function should be called once in each thread before calling other library functions to make sure that thread-local storage was allocated properly.< / p >
< div class = "variablelist" > < table border = "0" >
< col align = "left" >
< tbody > < tr >
< td > < span class = "term" > < i > < tt > Returns< / tt > < / i > :< / span > < / td >
2025-03-27 15:17:22 +01:00
< td > 0 on success or -1 if a memory allocation failed. A failed allocation signals a typically fatal and irrecoverable out-of-memory situation. Don't call any library functions in this case. Available since 2.12.0.< / td >
2023-11-04 19:07:37 +01:00
< / tr > < / tbody >
< / table > < / div >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
2022-08-24 14:34:04 +02:00
< a name = "xmlCleanupThreads" > < / a > xmlCleanupThreads ()< / h3 >
< pre class = "programlisting" > void xmlCleanupThreads (void)< br >
< / pre >
2023-04-26 21:21:31 +02:00
< p > DEPRECATED: This function is a no-op. Call < a href = "libxml2-parser.html#xmlCleanupParser" > xmlCleanupParser< / a > to free global state but see the warnings there. < a href = "libxml2-parser.html#xmlCleanupParser" > xmlCleanupParser< / a > should be only called once at program exit. In most cases, you don't have call cleanup functions at all.< / p >
2022-08-24 14:34:04 +02:00
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlFreeMutex" > < / a > xmlFreeMutex ()< / h3 >
< pre class = "programlisting" > void xmlFreeMutex (< a href = "libxml2-threads.html#xmlMutexPtr" > xmlMutexPtr< / a > tok)< br >
< / pre >
2023-04-26 21:21:31 +02:00
< p > Free a mutex.< / p >
2022-08-24 14:34:04 +02:00
< div class = "variablelist" > < table border = "0" >
< col align = "left" >
< tbody > < tr >
< td > < span class = "term" > < i > < tt > tok< / tt > < / i > :< / span > < / td >
< td > the simple mutex< / td >
< / tr > < / tbody >
< / table > < / div >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlFreeRMutex" > < / a > xmlFreeRMutex ()< / h3 >
< pre class = "programlisting" > void xmlFreeRMutex (< a href = "libxml2-threads.html#xmlRMutexPtr" > xmlRMutexPtr< / a > tok)< br >
< / pre >
< p > xmlRFreeMutex() is used to reclaim resources associated with a reentrant mutex.< / p >
< div class = "variablelist" > < table border = "0" >
< col align = "left" >
< tbody > < tr >
< td > < span class = "term" > < i > < tt > tok< / tt > < / i > :< / span > < / td >
< td > the reentrant mutex< / td >
< / tr > < / tbody >
< / table > < / div >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlInitThreads" > < / a > xmlInitThreads ()< / h3 >
< pre class = "programlisting" > void xmlInitThreads (void)< br >
< / pre >
2023-04-26 21:21:31 +02:00
< p > DEPRECATED: Alias for < a href = "libxml2-parser.html#xmlInitParser" > xmlInitParser< / a > .< / p >
2022-08-24 14:34:04 +02:00
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlLockLibrary" > < / a > xmlLockLibrary ()< / h3 >
< pre class = "programlisting" > void xmlLockLibrary (void)< br >
< / pre >
< p > xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 library.< / p >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlMutexLock" > < / a > xmlMutexLock ()< / h3 >
< pre class = "programlisting" > void xmlMutexLock (< a href = "libxml2-threads.html#xmlMutexPtr" > xmlMutexPtr< / a > tok)< br >
< / pre >
< p > xmlMutexLock() is used to lock a libxml2 token.< / p >
< div class = "variablelist" > < table border = "0" >
< col align = "left" >
< tbody > < tr >
< td > < span class = "term" > < i > < tt > tok< / tt > < / i > :< / span > < / td >
< td > the simple mutex< / td >
< / tr > < / tbody >
< / table > < / div >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlMutexUnlock" > < / a > xmlMutexUnlock ()< / h3 >
< pre class = "programlisting" > void xmlMutexUnlock (< a href = "libxml2-threads.html#xmlMutexPtr" > xmlMutexPtr< / a > tok)< br >
< / pre >
< p > xmlMutexUnlock() is used to unlock a libxml2 token.< / p >
< div class = "variablelist" > < table border = "0" >
< col align = "left" >
< tbody > < tr >
< td > < span class = "term" > < i > < tt > tok< / tt > < / i > :< / span > < / td >
< td > the simple mutex< / td >
< / tr > < / tbody >
< / table > < / div >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlNewMutex" > < / a > xmlNewMutex ()< / h3 >
< pre class = "programlisting" > < a href = "libxml2-threads.html#xmlMutexPtr" > xmlMutexPtr< / a > xmlNewMutex (void)< br >
< / pre >
< p > xmlNewMutex() is used to allocate a libxml2 token struct for use in synchronizing access to data.< / p >
< div class = "variablelist" > < table border = "0" >
< col align = "left" >
< tbody > < tr >
< td > < span class = "term" > < i > < tt > Returns< / tt > < / i > :< / span > < / td >
< td > a new simple mutex pointer or NULL in case of error< / td >
< / tr > < / tbody >
< / table > < / div >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlNewRMutex" > < / a > xmlNewRMutex ()< / h3 >
< pre class = "programlisting" > < a href = "libxml2-threads.html#xmlRMutexPtr" > xmlRMutexPtr< / a > xmlNewRMutex (void)< br >
< / pre >
< p > xmlRNewMutex() is used to allocate a reentrant mutex for use in synchronizing access to data. token_r is a re-entrant lock and thus useful for synchronizing access to data structures that may be manipulated in a recursive fashion.< / p >
< div class = "variablelist" > < table border = "0" >
< col align = "left" >
< tbody > < tr >
< td > < span class = "term" > < i > < tt > Returns< / tt > < / i > :< / span > < / td >
< td > the new reentrant mutex pointer or NULL in case of error< / td >
< / tr > < / tbody >
< / table > < / div >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlRMutexLock" > < / a > xmlRMutexLock ()< / h3 >
< pre class = "programlisting" > void xmlRMutexLock (< a href = "libxml2-threads.html#xmlRMutexPtr" > xmlRMutexPtr< / a > tok)< br >
< / pre >
< p > xmlRMutexLock() is used to lock a libxml2 token_r.< / p >
< div class = "variablelist" > < table border = "0" >
< col align = "left" >
< tbody > < tr >
< td > < span class = "term" > < i > < tt > tok< / tt > < / i > :< / span > < / td >
< td > the reentrant mutex< / td >
< / tr > < / tbody >
< / table > < / div >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlRMutexUnlock" > < / a > xmlRMutexUnlock ()< / h3 >
< pre class = "programlisting" > void xmlRMutexUnlock (< a href = "libxml2-threads.html#xmlRMutexPtr" > xmlRMutexPtr< / a > tok)< br >
< / pre >
< p > xmlRMutexUnlock() is used to unlock a libxml2 token_r.< / p >
< div class = "variablelist" > < table border = "0" >
< col align = "left" >
< tbody > < tr >
< td > < span class = "term" > < i > < tt > tok< / tt > < / i > :< / span > < / td >
< td > the reentrant mutex< / td >
< / tr > < / tbody >
< / table > < / div >
< / div >
< hr >
< div class = "refsect2" lang = "en" >
< h3 >
< a name = "xmlUnlockLibrary" > < / a > xmlUnlockLibrary ()< / h3 >
< pre class = "programlisting" > void xmlUnlockLibrary (void)< br >
< / pre >
< p > xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 library.< / p >
< / div >
< hr >
< / div >
< / div >
< / body >
2005-09-12 13:10:09 +00:00
< / html >
