diff options
Diffstat (limited to 'docs/doxygen/nel/a03383.html')
| -rw-r--r-- | docs/doxygen/nel/a03383.html | 239 |
1 files changed, 239 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03383.html b/docs/doxygen/nel/a03383.html new file mode 100644 index 00000000..252f4abd --- /dev/null +++ b/docs/doxygen/nel/a03383.html @@ -0,0 +1,239 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLMISC::CSharedMutex class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLMISC::CSharedMutex Class Reference</h1><code>#include <<a class="el" href="a06088.html">mutex.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Windows: uses Mutex, the handle can't be shared among processes, but the mutex still can be be shared by passing a common object name to createByName() / <a class="el" href="a03383.html#NLMISC_1_1CSharedMutexa0">createByKey()</a>. Note: the mutex must be explicitely destroyed by calling <a class="el" href="a03383.html#NLMISC_1_1CSharedMutexa2">destroy()</a>.<p> +<dl compact><dt><b>Author:</b></dt><dd>Olivier Cado <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2002 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06088.html#l00404">404</a> of file <a class="el" href="a06088.html">mutex.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03383.html#NLMISC_1_1CSharedMutexa0">createByKey</a> (int key, bool createNew)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create (with createNew to true) or access an existing mutex (created by another process) with a specific key. Returns false if it failed. <a href="#NLMISC_1_1CSharedMutexa0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03383.html#NLMISC_1_1CSharedMutexa1">CSharedMutex</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor (does not create the mutex, see createByName()/createByKey()). <a href="#NLMISC_1_1CSharedMutexa1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03383.html#NLMISC_1_1CSharedMutexa2">destroy</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the mutex. <a href="#NLMISC_1_1CSharedMutexa2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03383.html#NLMISC_1_1CSharedMutexa3">enter</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Enter the critical section. <a href="#NLMISC_1_1CSharedMutexa3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03383.html#NLMISC_1_1CSharedMutexa4">leave</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Leave the critical section. <a href="#NLMISC_1_1CSharedMutexa4"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="a03383.html#NLMISC_1_1CSharedMutexr0">_SemId</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The semaphore id. <a href="#NLMISC_1_1CSharedMutexr0"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLMISC_1_1CSharedMutexa1" doxytag="NLMISC::CSharedMutex::CSharedMutex" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLMISC::CSharedMutex::CSharedMutex </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor (does not create the mutex, see createByName()/createByKey()). +<p> + </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLMISC_1_1CSharedMutexa0" doxytag="NLMISC::CSharedMutex::createByKey" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLMISC::CSharedMutex::createByKey </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname" nowrap> <em>key</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>createNew</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create (with createNew to true) or access an existing mutex (created by another process) with a specific key. Returns false if it failed. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CSharedMutexa2" doxytag="NLMISC::CSharedMutex::destroy" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLMISC::CSharedMutex::destroy </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destroy the mutex. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CSharedMutexa3" doxytag="NLMISC::CSharedMutex::enter" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLMISC::CSharedMutex::enter </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Enter the critical section. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CSharedMutexa4" doxytag="NLMISC::CSharedMutex::leave" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLMISC::CSharedMutex::leave </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Leave the critical section. +<p> + </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLMISC_1_1CSharedMutexr0" doxytag="NLMISC::CSharedMutex::_SemId" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> int <a class="el" href="a03383.html#NLMISC_1_1CSharedMutexr0">NLMISC::CSharedMutex::_SemId</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The semaphore id. +<p> + +<p> +Definition at line <a class="el" href="a06088.html#l00435">435</a> of file <a class="el" href="a06088.html">mutex.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06088.html">mutex.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:32:44 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |