<!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>GNU CommonC++: ost::Lockfile Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_lockfile.html">Lockfile</a></div>
<h1>ost::Lockfile Class Reference</h1><!-- doxytag: class="ost::Lockfile" -->This class is used to create a "named" lock entity that can be used to control access to a resource between multiple processes.System-wide named lock.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="process_8h-source.html">process.h</a>></code>
<p>
<a href="classost_1_1_lockfile-members.html">List of all members.</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#650710f23bf875e3ea52ae95b2239d74">Lockfile</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a lock under a known name. <a href="#650710f23bf875e3ea52ae95b2239d74"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#8b743f029d010f77ce1d438c603005e7">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="#8b743f029d010f77ce1d438c603005e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#e3cd7ce383a40bfe81cdf827cc1131e3">~Lockfile</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the current lock and release it. <a href="#e3cd7ce383a40bfe81cdf827cc1131e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#1564016ea1fc36677921739d0307f937">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="#1564016ea1fc36677921739d0307f937"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#fb828f1455df52d734b940c7ba8507d2">unlock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release an acquired lock. <a href="#fb828f1455df52d734b940c7ba8507d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_lockfile.html#4172440e8c67b7c2b3e6646c3186d4c2">isLocked</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flag if the current process has aqcuired a lock. <a href="#4172440e8c67b7c2b3e6646c3186d4c2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class is used to create a "named" lock entity that can be used to control access to a resource between multiple processes.System-wide named lock.
<p>
The posix implimentation uses a pidfile and the win32 version uses a globally visible mutex.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="650710f23bf875e3ea52ae95b2239d74"></a><!-- doxytag: member="ost::Lockfile::Lockfile" ref="650710f23bf875e3ea52ae95b2239d74" args="(const char *name)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::Lockfile::Lockfile </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </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>
Create a lock under a known name.
<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="8b743f029d010f77ce1d438c603005e7"></a><!-- doxytag: member="ost::Lockfile::Lockfile" ref="8b743f029d010f77ce1d438c603005e7" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::Lockfile::Lockfile </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>
Create a new lock object that can be used to make locks.
<p>
</td>
</tr>
</table>
<a class="anchor" name="e3cd7ce383a40bfe81cdf827cc1131e3"></a><!-- doxytag: member="ost::Lockfile::~Lockfile" ref="e3cd7ce383a40bfe81cdf827cc1131e3" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::Lockfile::~Lockfile </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destroy the current lock and release it.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4172440e8c67b7c2b3e6646c3186d4c2"></a><!-- doxytag: member="ost::Lockfile::isLocked" ref="4172440e8c67b7c2b3e6646c3186d4c2" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::Lockfile::isLocked </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </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>
Flag if the current process has aqcuired a lock.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if we have the lock. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="1564016ea1fc36677921739d0307f937"></a><!-- doxytag: member="ost::Lockfile::lock" ref="1564016ea1fc36677921739d0307f937" args="(const char *name)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::Lockfile::lock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </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>
Lock a system-wide name for this process.
<p>
If the lock is successful, return true. If an existing lock was already acquired, release it first.<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if lock successful. </dd></dl>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="fb828f1455df52d734b940c7ba8507d2"></a><!-- doxytag: member="ost::Lockfile::unlock" ref="fb828f1455df52d734b940c7ba8507d2" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Lockfile::unlock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </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>
Release an acquired lock.
<p>
</td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
