From 35a201cc8ef0c3f5b2df88d2e528aabee1048348 Mon Sep 17 00:00:00 2001 From: Wojtek Kosior Date: Fri, 30 Apr 2021 18:47:09 +0200 Subject: Initial/Final commit --- libxml2-2.9.10/doc/html/libxml-threads.html | 72 +++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 libxml2-2.9.10/doc/html/libxml-threads.html (limited to 'libxml2-2.9.10/doc/html/libxml-threads.html') diff --git a/libxml2-2.9.10/doc/html/libxml-threads.html b/libxml2-2.9.10/doc/html/libxml-threads.html new file mode 100644 index 0000000..5837a78 --- /dev/null +++ b/libxml2-2.9.10/doc/html/libxml-threads.html @@ -0,0 +1,72 @@ + + +Module threads from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module threads from libxml2

API Menu
API Indexes
Related links
PrevschematronUpAPI documentationHomeThe XML C parser and toolkit of GnometreeNext

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)

+

+
hinstDLL:
fdwReason:
lpvReserved:
Returns:

Function: xmlFreeMutex

void	xmlFreeMutex			(xmlMutexPtr tok)

+

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

+
tok:the simple mutex

Function: xmlFreeRMutex

void	xmlFreeRMutex			(xmlRMutexPtr tok)

+

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

+
tok:the reentrant mutex

Function: xmlGetGlobalState

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

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

+
Returns:the current thread ID number

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.

+
Returns:1 if the current thread is the main thread, 0 otherwise

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.

+
tok:the simple mutex

Function: xmlMutexUnlock

void	xmlMutexUnlock			(xmlMutexPtr tok)

+

xmlMutexUnlock() is used to unlock a libxml2 token.

+
tok:the simple mutex

Function: xmlNewMutex

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

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.

+
Returns:the new reentrant mutex pointer or NULL in case of error

Function: xmlRMutexLock

void	xmlRMutexLock			(xmlRMutexPtr tok)

+

xmlRMutexLock() is used to lock a libxml2 token_r.

+
tok:the reentrant mutex

Function: xmlRMutexUnlock

void	xmlRMutexUnlock			(xmlRMutexPtr tok)

+

xmlRMutexUnlock() is used to unlock a libxml2 token_r.

+
tok:the reentrant mutex

Function: xmlUnlockLibrary

void	xmlUnlockLibrary		(void)

+

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

+

Daniel Veillard

-- cgit v1.2.3