<html> <head> <title>Methods of Class Mutex</title> <link rel="stylesheet" type="text/css" href="../../../cpp.css"> </head> <body> <div id="adc-cppref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0"> <tr align="center" valign="top"> <td class="navimain"> <a href="../../../index.html">Overview</a> </td> <td class="navimain"> <a href="../index.html">Namespace</a> </td> <td class="navimain"> <a href="../c-Mutex.html">Class</a> </td> <td class="navimain"> <a href="../../../index-files/index-1.html">Index</a> </td> <td class="navimain"> <a href="../../../help.html">Help</a> </td> </tr> </table> <table class="navisub" cellpadding="0" cellspacing="3"></table> <hr> <div class="title"><h2>Methods of Class Mutex</h2> </div><hr> <dl class="member"> <dt class="member"><a name="Mutex-90"> </a>Mutex</dt> <dd class="member"><dl> <dt class="simple"> <strong>Mutex</strong>();</dt> <dd><table class="param-table"></table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Create a thread-local mutex. </pre></dd> <dt>Return</dt> <dd><pre>0 if the mutex could not be created, otherwise a handle to the mutex. </pre></dd> <dt>See Also</dt> <dd><a href="../../o-mutex.h.html#osl_createMutex-884">::osl_createMutex()</a> <br> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="~Mutex-91"> </a>~Mutex</dt> <dd class="member"><dl> <dt class="simple"> <strong>~Mutex</strong>();</dt> <dd><table class="param-table"></table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Release the OS-structures and free mutex data-structure. </pre></dd> <dt>See Also</dt> <dd><a href="../../o-mutex.h.html#osl_destroyMutex-885">::osl_destroyMutex()</a> <br> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="acquire-92"> </a>acquire</dt> <dd class="member"><dl> <dt class="simple"><a href="../../t-sal_Bool.html">sal_Bool</a> <strong>acquire</strong>();</dt> <dd><table class="param-table"></table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Acquire the mutex, block if already acquired by another thread. </pre></dd> <dt>Return</dt> <dd><pre>sal_False if system-call fails. </pre></dd> <dt>See Also</dt> <dd><a href="../../o-mutex.h.html#osl_acquireMutex-886">::osl_acquireMutex()</a> <br> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="tryToAcquire-93"> </a>tryToAcquire</dt> <dd class="member"><dl> <dt class="simple"><a href="../../t-sal_Bool.html">sal_Bool</a> <strong>tryToAcquire</strong>();</dt> <dd><table class="param-table"></table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Try to acquire the mutex without blocking. </pre></dd> <dt>Return</dt> <dd><pre>sal_False if it could not be acquired. </pre></dd> <dt>See Also</dt> <dd><a href="../../o-mutex.h.html#osl_tryToAcquireMutex-887">::osl_tryToAcquireMutex()</a> <br> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="release-94"> </a>release</dt> <dd class="member"><dl> <dt class="simple"><a href="../../t-sal_Bool.html">sal_Bool</a> <strong>release</strong>();</dt> <dd><table class="param-table"></table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Release the mutex. </pre></dd> <dt>Return</dt> <dd><pre>sal_False if system-call fails. </pre></dd> <dt>See Also</dt> <dd><a href="../../o-mutex.h.html#osl_releaseMutex-888">::osl_releaseMutex()</a> <br> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="Mutex-97"> </a>Mutex</dt> <dd class="member"><dl> <dt class="simple"> <strong>Mutex</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="../../osl/c-Mutex.html">Mutex</a> & </td> <td> );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>The underlying oslMutex has no reference count. </pre></dd> <dt>Description</dt> <dd><pre>Since the underlying oslMutex is not a reference counted object, copy constructed Mutex may work on an already destructed oslMutex object. </pre></dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="Mutex-98"> </a>Mutex</dt> <dd class="member"><dl> <dt class="simple"> <strong>Mutex</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="../../t-oslMutex.html">oslMutex</a> </td> <td> Mutex );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>The underlying oslMutex has no reference count. </pre></dd> <dt>Description</dt> <dd><pre>When destructed, the Mutex object destroys the undelying oslMutex, which might cause severe problems in case it's a temporary object. </pre></dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="operator=-99"> </a>operator=</dt> <dd class="member"><dl> <dt class="simple"><a href="../../osl/c-Mutex.html">Mutex</a> & <strong>operator=</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="../../osl/c-Mutex.html">Mutex</a> & </td> <td> );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>This assignment operator is private for the same reason as the copy constructor. </pre></dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="operator=-100"> </a>operator=</dt> <dd class="member"><dl> <dt class="simple"><a href="../../osl/c-Mutex.html">Mutex</a> & <strong>operator=</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="../../t-oslMutex.html">oslMutex</a> </td> <td> );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>This assignment operator is private for the same reason as the constructor taking a oslMutex argument. </pre></dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="getGlobalMutex-95"> </a>getGlobalMutex</dt> <dd class="member"><dl> <dt class="simple">static <a href="../../osl/c-Mutex.html">Mutex</a> * <strong>getGlobalMutex</strong>();</dt> <dd><table class="param-table"></table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Description</dt> <dd><pre>Returns a global static mutex object. The global and static mutex object can be used to initialize other static objects in a thread safe manner. </pre></dd> <dt>Return</dt> <dd><pre>the global mutex object </pre></dd> <dt>See Also</dt> <dd><a href="../../o-mutex.h.html#osl_getGlobalMutex-889">::osl_getGlobalMutex()</a> <br> </dd> </dl> </dd> </dl> <hr> <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-cppref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
9174
