libxml2/doc/html/libxml-threads.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>threads</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
   2         .synopsis, .classsynopsis {
   3             background: #eeeeee;
   4             border: solid 1px #aaaaaa;
   5             padding: 0.5em;
   6         }
   7         .programlisting {
   8             background: #eeeeff;
   9             border: solid 1px #aaaaff;
  10             padding: 0.5em;
  11         }
  12         .variablelist {
  13             padding: 4px;
  14             margin-left: 3em;
  15         }
  16         .navigation {
  17             background: #ffeeee;
  18             border: solid 1px #ffaaaa;
  19             margin-top: 0.5em;
  20             margin-bottom: 0.5em;
  21         }
  22         .navigation a {
  23             color: #770000;
  24         }
  25         .navigation a:visited {
  26             color: #550000;
  27         }
  28         .navigation .title {
  29             font-size: 200%;
  30         }
  31       </style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual"><link rel="up" href="libxml-lib.html" title="Libxml Library Reference"><link rel="previous" href="libxml-c14n.html" title="c14n"><link rel="next" href="libxml-globals.html" title="globals"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-c14n.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td><td><a accesskey="u" href="libxml-lib.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td><th width="100%" align="center">Gnome XML Library Reference Manual</th><td><a accesskey="n" href="libxml-globals.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td></tr></table><div class="refentry" lang="en"><a name="libxml-threads"></a><div class="titlepage"></div><div class="refnamediv"><h2>threads</h2><p>threads &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  32
  33
  34
  35 struct      <a href="libxml-threads.html#xmlMutex">xmlMutex</a>;
  36 typedef     <a href="libxml-threads.html#xmlMutexPtr">xmlMutexPtr</a>;
  37 struct      <a href="libxml-threads.html#xmlRMutex">xmlRMutex</a>;
  38 typedef     <a href="libxml-threads.html#xmlRMutexPtr">xmlRMutexPtr</a>;
  39 <a href="libxml-threads.html#xmlMutexPtr">xmlMutexPtr</a> <a href="libxml-threads.html#xmlNewMutex">xmlNewMutex</a>                     (void);
  40 void        <a href="libxml-threads.html#xmlMutexLock">xmlMutexLock</a>                    (<a href="libxml-threads.html#xmlMutexPtr">xmlMutexPtr</a> tok);
  41 void        <a href="libxml-threads.html#xmlMutexUnlock">xmlMutexUnlock</a>                  (<a href="libxml-threads.html#xmlMutexPtr">xmlMutexPtr</a> tok);
  42 void        <a href="libxml-threads.html#xmlFreeMutex">xmlFreeMutex</a>                    (<a href="libxml-threads.html#xmlMutexPtr">xmlMutexPtr</a> tok);
  43 <a href="libxml-threads.html#xmlRMutexPtr">xmlRMutexPtr</a> <a href="libxml-threads.html#xmlNewRMutex">xmlNewRMutex</a>                   (void);
  44 void        <a href="libxml-threads.html#xmlRMutexLock">xmlRMutexLock</a>                   (<a href="libxml-threads.html#xmlRMutexPtr">xmlRMutexPtr</a> tok);
  45 void        <a href="libxml-threads.html#xmlRMutexUnlock">xmlRMutexUnlock</a>                 (<a href="libxml-threads.html#xmlRMutexPtr">xmlRMutexPtr</a> tok);
  46 void        <a href="libxml-threads.html#xmlFreeRMutex">xmlFreeRMutex</a>                   (<a href="libxml-threads.html#xmlRMutexPtr">xmlRMutexPtr</a> tok);
  47 void        <a href="libxml-threads.html#xmlInitThreads">xmlInitThreads</a>                  (void);
  48 void        <a href="libxml-threads.html#xmlLockLibrary">xmlLockLibrary</a>                  (void);
  49 void        <a href="libxml-threads.html#xmlUnlockLibrary">xmlUnlockLibrary</a>                (void);
  50 int         <a href="libxml-threads.html#xmlGetThreadId">xmlGetThreadId</a>                  (void);
  51 int         <a href="libxml-threads.html#xmlIsMainThread">xmlIsMainThread</a>                 (void);
  52 void        <a href="libxml-threads.html#xmlCleanupThreads">xmlCleanupThreads</a>               (void);
  53 <a href="libxml-globals.html#xmlGlobalStatePtr">xmlGlobalStatePtr</a> <a href="libxml-threads.html#xmlGetGlobalState">xmlGetGlobalState</a>         (void);
  54 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
  55
  56 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="xmlMutex"></a>struct xmlMutex</h3><pre class="programlisting">struct xmlMutex;</pre><p>
  57
  58 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlMutexPtr"></a>xmlMutexPtr</h3><pre class="programlisting">typedef xmlMutex *xmlMutexPtr;
  59 </pre><p>
  60
  61 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRMutex"></a>struct xmlRMutex</h3><pre class="programlisting">struct xmlRMutex;</pre><p>
  62
  63 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRMutexPtr"></a>xmlRMutexPtr</h3><pre class="programlisting">typedef xmlRMutex *xmlRMutexPtr;
  64 </pre><p>
  65
  66 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewMutex"></a>xmlNewMutex ()</h3><pre class="programlisting"><a href="libxml-threads.html#xmlMutexPtr">xmlMutexPtr</a> xmlNewMutex                     (void);</pre><p>
  67 <a href="libxml-threads.html#xmlNewMutex">xmlNewMutex</a>() is used to allocate a libxml2 token struct for use in
  68 synchronizing access to data.</p><p>
  69
  70 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new simple mutex pointer or NULL in case of error
  71 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlMutexLock"></a>xmlMutexLock ()</h3><pre class="programlisting">void        xmlMutexLock                    (<a href="libxml-threads.html#xmlMutexPtr">xmlMutexPtr</a> tok);</pre><p>
  72 <a href="libxml-threads.html#xmlMutexLock">xmlMutexLock</a>() is used to lock a libxml2 token.</p><p>
  73
  74 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>tok</tt></i> :</span></td><td>  the simple mutex
  75 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlMutexUnlock"></a>xmlMutexUnlock ()</h3><pre class="programlisting">void        xmlMutexUnlock                  (<a href="libxml-threads.html#xmlMutexPtr">xmlMutexPtr</a> tok);</pre><p>
  76 <a href="libxml-threads.html#xmlMutexUnlock">xmlMutexUnlock</a>() is used to unlock a libxml2 token.</p><p>
  77
  78 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>tok</tt></i> :</span></td><td>  the simple mutex
  79 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFreeMutex"></a>xmlFreeMutex ()</h3><pre class="programlisting">void        xmlFreeMutex                    (<a href="libxml-threads.html#xmlMutexPtr">xmlMutexPtr</a> tok);</pre><p>
  80 <a href="libxml-threads.html#xmlFreeMutex">xmlFreeMutex</a>() is used to reclaim resources associated with a libxml2 token
  81 struct.</p><p>
  82
  83 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>tok</tt></i> :</span></td><td>  the simple mutex
  84 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewRMutex"></a>xmlNewRMutex ()</h3><pre class="programlisting"><a href="libxml-threads.html#xmlRMutexPtr">xmlRMutexPtr</a> xmlNewRMutex                   (void);</pre><p>
  85 <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xmlRNewMutex">xmlRNewMutex</GTKDOCLINK>() is used to allocate a reentrant mutex for use in
  86 synchronizing access to data. token_r is a re-entrant lock and thus useful
  87 for synchronizing access to data structures that may be manipulated in a
  88 recursive fashion.</p><p>
  89
  90 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new reentrant mutex pointer or NULL in case of error
  91 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRMutexLock"></a>xmlRMutexLock ()</h3><pre class="programlisting">void        xmlRMutexLock                   (<a href="libxml-threads.html#xmlRMutexPtr">xmlRMutexPtr</a> tok);</pre><p>
  92 <a href="libxml-threads.html#xmlRMutexLock">xmlRMutexLock</a>() is used to lock a libxml2 token_r.</p><p>
  93
  94 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>tok</tt></i> :</span></td><td>  the reentrant mutex
  95 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRMutexUnlock"></a>xmlRMutexUnlock ()</h3><pre class="programlisting">void        xmlRMutexUnlock                 (<a href="libxml-threads.html#xmlRMutexPtr">xmlRMutexPtr</a> tok);</pre><p>
  96 <a href="libxml-threads.html#xmlRMutexUnlock">xmlRMutexUnlock</a>() is used to unlock a libxml2 token_r.</p><p>
  97
  98 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>tok</tt></i> :</span></td><td>  the reentrant mutex
  99 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFreeRMutex"></a>xmlFreeRMutex ()</h3><pre class="programlisting">void        xmlFreeRMutex                   (<a href="libxml-threads.html#xmlRMutexPtr">xmlRMutexPtr</a> tok);</pre><p>
 100 <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xmlRFreeMutex">xmlRFreeMutex</GTKDOCLINK>() is used to reclaim resources associated with a
 101 reentrant mutex.</p><p>
 102
 103 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>tok</tt></i> :</span></td><td>  the reentrant mutex
 104 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlInitThreads"></a>xmlInitThreads ()</h3><pre class="programlisting">void        xmlInitThreads                  (void);</pre><p>
 105 <a href="libxml-threads.html#xmlInitThreads">xmlInitThreads</a>() is used to to initialize all the thread related
 106 data of the libxml2 library.</p><p>
 107
 108 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlLockLibrary"></a>xmlLockLibrary ()</h3><pre class="programlisting">void        xmlLockLibrary                  (void);</pre><p>
 109 <a href="libxml-threads.html#xmlLockLibrary">xmlLockLibrary</a>() is used to take out a re-entrant lock on the libxml2
 110 library.</p><p>
 111
 112 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlUnlockLibrary"></a>xmlUnlockLibrary ()</h3><pre class="programlisting">void        xmlUnlockLibrary                (void);</pre><p>
 113 <a href="libxml-threads.html#xmlUnlockLibrary">xmlUnlockLibrary</a>() is used to release a re-entrant lock on the libxml2
 114 library.</p><p>
 115
 116 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlGetThreadId"></a>xmlGetThreadId ()</h3><pre class="programlisting">int         xmlGetThreadId                  (void);</pre><p>
 117 <a href="libxml-threads.html#xmlGetThreadId">xmlGetThreadId</a>() find the current thread ID number</p><p>
 118
 119 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the current thread ID number
 120 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsMainThread"></a>xmlIsMainThread ()</h3><pre class="programlisting">int         xmlIsMainThread                 (void);</pre><p>
 121 <a href="libxml-threads.html#xmlIsMainThread">xmlIsMainThread</a>() check whether the current thread is the main thread.</p><p>
 122
 123 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if the current thread is the main thread, 0 otherwise
 124 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCleanupThreads"></a>xmlCleanupThreads ()</h3><pre class="programlisting">void        xmlCleanupThreads               (void);</pre><p>
 125 <a href="libxml-threads.html#xmlCleanupThreads">xmlCleanupThreads</a>() is used to to cleanup all the thread related
 126 data of the libxml2 library once processing has ended.</p><p>
 127
 128 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlGetGlobalState"></a>xmlGetGlobalState ()</h3><pre class="programlisting"><a href="libxml-globals.html#xmlGlobalStatePtr">xmlGlobalStatePtr</a> xmlGetGlobalState         (void);</pre><p>
 129 <a href="libxml-threads.html#xmlGetGlobalState">xmlGetGlobalState</a>() is called to retrieve the global state for a thread.</p><p>
 130
 131 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the thread global state or NULL in case of error
 132 </td></tr></tbody></table></div></div></div></div><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxml-c14n.html"><b>&lt;&lt; c14n</b></a></td><td align="right"><a accesskey="n" href="libxml-globals.html"><b>globals &gt;&gt;</b></a></td></tr></table></body></html>