deps/src/libxml2-2.9.1/doc/devhelp/libxml2-threads.html
| | | | | libxml2 Reference Manual |
threads - interfaces for thread handling
set of generic threading related routines should work with pthreads, Windows native or TLS threads
Author(s): Daniel Veillard
typedef struct _xmlMutex[xmlMutex](#xmlMutex);
typedef struct _xmlRMutex[xmlRMutex](#xmlRMutex);
typedef[xmlRMutex](libxml2-threads.html#xmlRMutex)*[xmlRMutexPtr](#xmlRMutexPtr);
typedef[xmlMutex](libxml2-threads.html#xmlMutex)*[xmlMutexPtr](#xmlMutexPtr);
void[xmlFreeRMutex](#xmlFreeRMutex)([xmlRMutexPtr](libxml2-threads.html#xmlRMutexPtr)tok);
int[xmlGetThreadId](#xmlGetThreadId)(void);
void[xmlMutexUnlock](#xmlMutexUnlock)([xmlMutexPtr](libxml2-threads.html#xmlMutexPtr)tok);
void[xmlCleanupThreads](#xmlCleanupThreads)(void);
void[xmlLockLibrary](#xmlLockLibrary)(void);[xmlRMutexPtr](libxml2-threads.html#xmlRMutexPtr)[xmlNewRMutex](#xmlNewRMutex)(void);
void[xmlMutexLock](#xmlMutexLock)([xmlMutexPtr](libxml2-threads.html#xmlMutexPtr)tok);
int[xmlIsMainThread](#xmlIsMainThread)(void);
void[xmlRMutexUnlock](#xmlRMutexUnlock)([xmlRMutexPtr](libxml2-threads.html#xmlRMutexPtr)tok);[xmlGlobalStatePtr](libxml2-globals.html#xmlGlobalStatePtr)[xmlGetGlobalState](#xmlGetGlobalState)(void);[xmlMutexPtr](libxml2-threads.html#xmlMutexPtr)[xmlNewMutex](#xmlNewMutex)(void);
int[xmlDllMain](#xmlDllMain)(void * hinstDLL,
unsigned long fdwReason,
void * lpvReserved);
void[xmlFreeMutex](#xmlFreeMutex)([xmlMutexPtr](libxml2-threads.html#xmlMutexPtr)tok);
void[xmlUnlockLibrary](#xmlUnlockLibrary)(void);
void[xmlInitThreads](#xmlInitThreads)(void);
void[xmlRMutexLock](#xmlRMutexLock)([xmlRMutexPtr](libxml2-threads.html#xmlRMutexPtr)tok);
struct _xmlMutex {
The content of this structure is not made public by the API.
} xmlMutex;
[xmlMutex](libxml2-threads.html#xmlMutex)* xmlMutexPtr;
struct _xmlRMutex {
The content of this structure is not made public by the API.
} xmlRMutex;
[xmlRMutex](libxml2-threads.html#xmlRMutex)* xmlRMutexPtr;
void xmlCleanupThreads (void)
xmlCleanupThreads() is used to to cleanup all the thread related data of the libxml2 library once processing has ended. WARNING: if your application is multithreaded or has plugin support calling this may crash the application if another thread or a plugin is still using libxml2. It's sometimes very hard to guess if libxml2 is in use in the application, some libraries or plugins may use it without notice. In case of doubt abstain from calling this function or do it just before calling exit() to avoid leak reports from valgrind !
int xmlDllMain (void * hinstDLL,
unsigned long fdwReason,
void * lpvReserved)
| hinstDLL: | | | fdwReason: | | | lpvReserved: | | | Returns: | |
void xmlFreeMutex ([xmlMutexPtr](libxml2-threads.html#xmlMutexPtr)tok)
xmlFreeMutex() is used to reclaim resources associated with a libxml2 token struct.
| tok: | the simple mutex |
void xmlFreeRMutex ([xmlRMutexPtr](libxml2-threads.html#xmlRMutexPtr)tok)
xmlRFreeMutex() is used to reclaim resources associated with a reentrant mutex.
| tok: | the reentrant mutex |
[xmlGlobalStatePtr](libxml2-globals.html#xmlGlobalStatePtr)xmlGetGlobalState (void)
xmlGetGlobalState() is called to retrieve the global state for a thread.
| Returns: | the thread global state or NULL in case of error |
int xmlGetThreadId (void)
xmlGetThreadId() find the current thread ID number Note that this is likely to be broken on some platforms using pthreads as the specification doesn't mandate pthread_t to be an integer type
| Returns: | the current thread ID number |
void xmlInitThreads (void)
xmlInitThreads() is used to to initialize all the thread related data of the libxml2 library.
int xmlIsMainThread (void)
xmlIsMainThread() check whether the current thread is the main thread.
| Returns: | 1 if the current thread is the main thread, 0 otherwise |
void xmlLockLibrary (void)
xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 library.
void xmlMutexLock ([xmlMutexPtr](libxml2-threads.html#xmlMutexPtr)tok)
xmlMutexLock() is used to lock a libxml2 token.
| tok: | the simple mutex |
void xmlMutexUnlock ([xmlMutexPtr](libxml2-threads.html#xmlMutexPtr)tok)
xmlMutexUnlock() is used to unlock a libxml2 token.
| tok: | the simple mutex |
[xmlMutexPtr](libxml2-threads.html#xmlMutexPtr)xmlNewMutex (void)
xmlNewMutex() is used to allocate a libxml2 token struct for use in synchronizing access to data.
| Returns: | a new simple mutex pointer or NULL in case of error |
[xmlRMutexPtr](libxml2-threads.html#xmlRMutexPtr)xmlNewRMutex (void)
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.
| Returns: | the new reentrant mutex pointer or NULL in case of error |
void xmlRMutexLock ([xmlRMutexPtr](libxml2-threads.html#xmlRMutexPtr)tok)
xmlRMutexLock() is used to lock a libxml2 token_r.
| tok: | the reentrant mutex |
void xmlRMutexUnlock ([xmlRMutexPtr](libxml2-threads.html#xmlRMutexPtr)tok)
xmlRMutexUnlock() is used to unlock a libxml2 token_r.
| tok: | the reentrant mutex |
void xmlUnlockLibrary (void)
xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 library.