1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>oscl_mutex.h File Reference</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5</head><body> 6<!-- Generated by Doxygen 1.2.18 --> 7<center> 8<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9<hr><h1>oscl_mutex.h File Reference</h1>This file provides implementation of mutex. 10<a href="#_details">More...</a> 11<p> 12<code>#include "<a class="el" href="osclconfig__proc_8h-source.html">osclconfig_proc.h</a>"</code><br> 13<code>#include "<a class="el" href="oscl__types_8h-source.html">oscl_types.h</a>"</code><br> 14<code>#include "<a class="el" href="oscl__base_8h-source.html">oscl_base.h</a>"</code><br> 15<code>#include "<a class="el" href="oscl__thread_8h-source.html">oscl_thread.h</a>"</code><br> 16<code>#include "<a class="el" href="oscl__lock__base_8h-source.html">oscl_lock_base.h</a>"</code><br> 17 18<p> 19<a href="oscl__mutex_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0> 20<tr><td></td></tr> 21<tr><td colspan=2><br><h2>Data Structures</h2></td></tr> 22<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclMutex.html">OsclMutex</a></td></tr> 23<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclThreadLock.html">OsclThreadLock</a></td></tr> 24<tr><td colspan=2><br><h2>Typedefs</h2></td></tr> 25<tr><td nowrap align=right valign=top>typedef <a class="el" href="classOsclMutex.html">OsclMutex</a> </td><td valign=bottom><a class="el" href="oscl__mutex_8h.html#a0">OsclNoYieldMutex</a></td></tr> 26</table> 27<hr><a name="_details"></a><h2>Detailed Description</h2> 28This file provides implementation of mutex. 29<p> 30 31<p> 32<hr><h2>Typedef Documentation</h2> 33<a name="a0" doxytag="oscl_mutex.h::OsclNoYieldMutex"></a><p> 34<table width="100%" cellpadding="2" cellspacing="0" border="0"> 35 <tr> 36 <td class="md"> 37 <table cellpadding="0" cellspacing="0" border="0"> 38 <tr> 39 <td class="md" nowrap valign="top"> typedef <a class="el" href="classOsclMutex.html">OsclMutex</a> OsclNoYieldMutex 40 </table> 41 </td> 42 </tr> 43</table> 44<table cellspacing=5 cellpadding=0 border=0> 45 <tr> 46 <td> 47 48 </td> 49 <td> 50 51<p> 52Class OsclNoYieldMutex can be used in use cases where there will be no CPU-yielding operation done while the Mutex is locked. 53<p> 54CPU-yielding operations include <a class="el" href="classOsclMutex.html#a3">OsclMutex::Lock</a>, OsclSemphore::Wait, OsclThread::Sleep, and OsclBrewThreadUtil::BThreadYield. 55<p> 56The 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. 57<p> 58An example of this type of use case is for simple data protection. </td> 59 </tr> 60</table> 61<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 62<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 63</small></address> 64</body> 65</html> 66
