blob: 8eaee877024c7c20fb129761f33b1f7a45ef450a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>oscl_mutex.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>oscl_mutex.h File Reference</h1>This file provides implementation of mutex.
<a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="osclconfig__proc_8h-source.html">osclconfig_proc.h</a>"</code><br>
<code>#include "<a class="el" href="oscl__types_8h-source.html">oscl_types.h</a>"</code><br>
<code>#include "<a class="el" href="oscl__base_8h-source.html">oscl_base.h</a>"</code><br>
<code>#include "<a class="el" href="oscl__thread_8h-source.html">oscl_thread.h</a>"</code><br>
<code>#include "<a class="el" href="oscl__lock__base_8h-source.html">oscl_lock_base.h</a>"</code><br>
<p>
<a href="oscl__mutex_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classOsclMutex.html">OsclMutex</a></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classOsclThreadLock.html">OsclThreadLock</a></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef <a class="el" href="classOsclMutex.html">OsclMutex</a>&nbsp;</td><td valign=bottom><a class="el" href="oscl__mutex_8h.html#a0">OsclNoYieldMutex</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This file provides implementation of mutex.
<p>
<p>
<hr><h2>Typedef Documentation</h2>
<a name="a0" doxytag="oscl_mutex.h::OsclNoYieldMutex"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef <a class="el" href="classOsclMutex.html">OsclMutex</a> OsclNoYieldMutex
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Class OsclNoYieldMutex can be used in use cases where there will be no CPU-yielding operation done while the Mutex is locked.
<p>
CPU-yielding operations include <a class="el" href="classOsclMutex.html#a3">OsclMutex::Lock</a>, OsclSemphore::Wait, OsclThread::Sleep, and OsclBrewThreadUtil::BThreadYield.
<p>
The behavior of OsclNoYieldMutex depends on whether the threading model is pre-emptive or not. When threading is pre-emptive, it is identical to <a class="el" href="classOsclMutex.html">OsclMutex</a>. When threading is non-pre-emptive, it is a NO-OP.
<p>
An example of this type of use case is for simple data protection. </td>
</tr>
</table>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>