schematron		API documentation		The XML C parser and toolkit of Gnome	tree

set of generic threading related routines should work with pthreads, Windows native or TLS threads

Table of Contents

Structure xmlMutex
struct _xmlMutex
The content of this structure is not made public by the API.

Typedef xmlMutex * xmlMutexPtr

Structure xmlRMutex
struct _xmlRMutex
The content of this structure is not made public by the API.

Typedef xmlRMutex * xmlRMutexPtr

void	xmlCleanupThreads		(void)

int	xmlDllMain			(void * hinstDLL, 
					 unsigned long fdwReason, 
					 void * lpvReserved)

void	xmlFreeMutex			(xmlMutexPtr tok)

void	xmlFreeRMutex			(xmlRMutexPtr tok)

xmlGlobalStatePtr	xmlGetGlobalState	(void)

int	xmlGetThreadId			(void)

void	xmlInitThreads			(void)

int	xmlIsMainThread			(void)

void	xmlLockLibrary			(void)

void	xmlMutexLock			(xmlMutexPtr tok)

void	xmlMutexUnlock			(xmlMutexPtr tok)

xmlMutexPtr	xmlNewMutex		(void)

xmlRMutexPtr	xmlNewRMutex		(void)

void	xmlRMutexLock			(xmlRMutexPtr tok)

void	xmlRMutexUnlock			(xmlRMutexPtr tok)

void	xmlUnlockLibrary		(void)

Description

Structure xmlMutex

Structure xmlMutex
struct _xmlMutex {
The content of this structure is not made public by the API.
}

Structure xmlRMutex

Structure xmlRMutex
struct _xmlRMutex {
The content of this structure is not made public by the API.
}

Function: xmlCleanupThreads

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 !

Function: xmlDllMain

int	xmlDllMain			(void * hinstDLL, 
					 unsigned long fdwReason, 
					 void * lpvReserved)

Function: xmlFreeMutex

void	xmlFreeMutex			(xmlMutexPtr tok)

xmlFreeMutex() is used to reclaim resources associated with a libxml2 token struct.

Function: xmlFreeRMutex

void	xmlFreeRMutex			(xmlRMutexPtr tok)

xmlRFreeMutex() is used to reclaim resources associated with a reentrant mutex.

Function: xmlGetGlobalState

xmlGlobalStatePtr	xmlGetGlobalState	(void)

xmlGetGlobalState() is called to retrieve the global state for a thread.

Function: xmlGetThreadId

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

Function: xmlInitThreads

void	xmlInitThreads			(void)

xmlInitThreads() is used to to initialize all the thread related data of the libxml2 library.

Function: xmlIsMainThread

int	xmlIsMainThread			(void)

xmlIsMainThread() check whether the current thread is the main thread.

Function: xmlLockLibrary

void	xmlLockLibrary			(void)

xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 library.

Function: xmlMutexLock

void	xmlMutexLock			(xmlMutexPtr tok)

xmlMutexLock() is used to lock a libxml2 token.

Function: xmlMutexUnlock

void	xmlMutexUnlock			(xmlMutexPtr tok)

xmlMutexUnlock() is used to unlock a libxml2 token.

Function: xmlNewMutex

xmlMutexPtr	xmlNewMutex		(void)

xmlNewMutex() is used to allocate a libxml2 token struct for use in synchronizing access to data.

Function: xmlNewRMutex

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.

Function: xmlRMutexLock

void	xmlRMutexLock			(xmlRMutexPtr tok)

xmlRMutexLock() is used to lock a libxml2 token_r.

Function: xmlRMutexUnlock

void	xmlRMutexUnlock			(xmlRMutexPtr tok)

xmlRMutexUnlock() is used to unlock a libxml2 token_r.

Function: xmlUnlockLibrary

void	xmlUnlockLibrary		(void)

xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 library.

Daniel Veillard