<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU CommonC++: ost::Lockfile Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_lockfile.html">Lockfile</a> </div> </div> <div class="contents"> <h1>ost::Lockfile Class Reference</h1><!-- doxytag: class="ost::Lockfile" --> <p>This class is used to create a "named" lock entity that can be used to control access to a resource between multiple processes. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="process_8h_source.html">process.h</a>></code></p> <p><a href="classost_1_1_lockfile-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#a650710f23bf875e3ea52ae95b2239d74">Lockfile</a> (const char *name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a lock under a known name. <a href="#a650710f23bf875e3ea52ae95b2239d74"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#a8b743f029d010f77ce1d438c603005e7">Lockfile</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new lock object that can be used to make locks. <a href="#a8b743f029d010f77ce1d438c603005e7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#ae3cd7ce383a40bfe81cdf827cc1131e3">~Lockfile</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the current lock and release it. <a href="#ae3cd7ce383a40bfe81cdf827cc1131e3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#a1564016ea1fc36677921739d0307f937">lock</a> (const char *name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Lock a system-wide name for this process. <a href="#a1564016ea1fc36677921739d0307f937"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#afb828f1455df52d734b940c7ba8507d2">unlock</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Release an acquired lock. <a href="#afb828f1455df52d734b940c7ba8507d2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#a4172440e8c67b7c2b3e6646c3186d4c2">isLocked</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Flag if the current process has aqcuired a lock. <a href="#a4172440e8c67b7c2b3e6646c3186d4c2"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>This class is used to create a "named" lock entity that can be used to control access to a resource between multiple processes. </p> <p>The posix implimentation uses a pidfile and the win32 version uses a globally visible mutex.</p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> System-wide named lock </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a650710f23bf875e3ea52ae95b2239d74"></a><!-- doxytag: member="ost::Lockfile::Lockfile" ref="a650710f23bf875e3ea52ae95b2239d74" args="(const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::Lockfile::Lockfile </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create a lock under a known name. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of system-wide lock to create. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a8b743f029d010f77ce1d438c603005e7"></a><!-- doxytag: member="ost::Lockfile::Lockfile" ref="a8b743f029d010f77ce1d438c603005e7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::Lockfile::Lockfile </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create a new lock object that can be used to make locks. </p> </div> </div> <a class="anchor" id="ae3cd7ce383a40bfe81cdf827cc1131e3"></a><!-- doxytag: member="ost::Lockfile::~Lockfile" ref="ae3cd7ce383a40bfe81cdf827cc1131e3" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::Lockfile::~Lockfile </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Destroy the current lock and release it. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a4172440e8c67b7c2b3e6646c3186d4c2"></a><!-- doxytag: member="ost::Lockfile::isLocked" ref="a4172440e8c67b7c2b3e6646c3186d4c2" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::Lockfile::isLocked </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Flag if the current process has aqcuired a lock. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>true if we have the lock. </dd></dl> </div> </div> <a class="anchor" id="a1564016ea1fc36677921739d0307f937"></a><!-- doxytag: member="ost::Lockfile::lock" ref="a1564016ea1fc36677921739d0307f937" args="(const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::Lockfile::lock </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Lock a system-wide name for this process. </p> <p>If the lock is successful, return true. If an existing lock was already acquired, release it first.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>true if lock successful. </dd></dl> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>system-wide lock to use. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="afb828f1455df52d734b940c7ba8507d2"></a><!-- doxytag: member="ost::Lockfile::unlock" ref="afb828f1455df52d734b940c7ba8507d2" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::Lockfile::unlock </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Release an acquired lock. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="process_8h_source.html">process.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Mar 12 10:07:41 2010 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>