libxml2_threads.h File Reference

Typedef xmlMutex

typedef struct _xmlMutexxmlMutex

Typedef xmlMutexPtr

typedef xmlMutex *xmlMutexPtr

Typedef xmlRMutex

typedef struct _xmlRMutexxmlRMutex

Typedef xmlRMutexPtr

typedef xmlRMutex *xmlRMutexPtr

xmlNewMutex ( void )

XMLPUBFUN xmlMutexPtr XMLCALLxmlNewMutex(void)

xmlNewMutex:

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

OOM: possible --> NULL is returned (OOM flag is NOT SET)

xmlMutexLock ( xmlMutexPtr )

XMLPUBFUN void XMLCALLxmlMutexLock(xmlMutexPtrtok)

xmlMutexLock: xmlMutexLock() is used to lock a libxml2 token.

Parameters
tokthe simple mutex

xmlMutexUnlock ( xmlMutexPtr )

XMLPUBFUN void XMLCALLxmlMutexUnlock(xmlMutexPtrtok)

xmlMutexUnlock: xmlMutexUnlock() is used to unlock a libxml2 token.

Parameters
tokthe simple mutex

xmlFreeMutex ( xmlMutexPtr )

XMLPUBFUN void XMLCALLxmlFreeMutex(xmlMutexPtrtok)

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

Parameters
tokthe simple mutex

xmlNewRMutex ( void )

XMLPUBFUN xmlRMutexPtr XMLCALLxmlNewRMutex(void)

xmlNewRMutex:

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

xmlRMutexLock ( xmlRMutexPtr )

XMLPUBFUN void XMLCALLxmlRMutexLock(xmlRMutexPtrtok)

xmlRMutexLock: xmlRMutexLock() is used to lock a libxml2 token_r.

Parameters
tokthe reentrant mutex

xmlRMutexUnlock ( xmlRMutexPtr )

XMLPUBFUN void XMLCALLxmlRMutexUnlock(xmlRMutexPtrtok)

xmlRMutexUnlock: xmlRMutexUnlock() is used to unlock a libxml2 token_r.

Parameters
tokthe reentrant mutex

xmlFreeRMutex ( xmlRMutexPtr )

XMLPUBFUN void XMLCALLxmlFreeRMutex(xmlRMutexPtrtok)

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

Parameters
tokthe reentrant mutex

xmlInitThreads ( void )

XMLPUBFUN void XMLCALLxmlInitThreads(void)

xmlInitThreads:

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

xmlLockLibrary ( void )

XMLPUBFUN void XMLCALLxmlLockLibrary(void)

xmlLockLibrary:

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

xmlUnlockLibrary ( void )

XMLPUBFUN void XMLCALLxmlUnlockLibrary(void)

xmlUnlockLibrary:

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

xmlGetThreadId ( void )

XMLPUBFUN int XMLCALLxmlGetThreadId(void)

xmlGetThreadId:

xmlGetThreadId() find the current thread ID number

Returns the current thread ID number

xmlIsMainThread ( void )

XMLPUBFUN int XMLCALLxmlIsMainThread(void)

xmlIsMainThread:

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

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

xmlCleanupThreads ( void )

XMLPUBFUN void XMLCALLxmlCleanupThreads(void)

xmlCleanupThreads:

xmlCleanupThreads() is used to to cleanup all the thread related data of the libxml2 library once processing has ended.

xmlGetGlobalState ( void )

XMLPUBFUN xmlGlobalStatePtr XMLCALLxmlGetGlobalState(void)

Retrieves a pointer to the 'global state' structure that contains all global settings

Initialization of global data is performed when first user of XML Engine calls XmlEngine::XmlEngineAttachL() or XmlEngine::XmlEnginePushL()

© Nokia 2005.