<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: ost::Lockfile Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_lockfile.html">Lockfile</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classost_1_1_lockfile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::Lockfile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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="classost_1_1_lockfile.html#details">More...</a></p>
<p><code>#include <<a class="el" href="process_8h_source.html">process.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a650710f23bf875e3ea52ae95b2239d74"><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 class="memdesc:a650710f23bf875e3ea52ae95b2239d74"><td class="mdescLeft"> </td><td class="mdescRight">Create a lock under a known name. <a href="#a650710f23bf875e3ea52ae95b2239d74">More...</a><br/></td></tr>
<tr class="separator:a650710f23bf875e3ea52ae95b2239d74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b743f029d010f77ce1d438c603005e7"><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 class="memdesc:a8b743f029d010f77ce1d438c603005e7"><td class="mdescLeft"> </td><td class="mdescRight">Create a new lock object that can be used to make locks. <a href="#a8b743f029d010f77ce1d438c603005e7">More...</a><br/></td></tr>
<tr class="separator:a8b743f029d010f77ce1d438c603005e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3cd7ce383a40bfe81cdf827cc1131e3"><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 class="memdesc:ae3cd7ce383a40bfe81cdf827cc1131e3"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the current lock and release it. <a href="#ae3cd7ce383a40bfe81cdf827cc1131e3">More...</a><br/></td></tr>
<tr class="separator:ae3cd7ce383a40bfe81cdf827cc1131e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1564016ea1fc36677921739d0307f937"><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 class="memdesc:a1564016ea1fc36677921739d0307f937"><td class="mdescLeft"> </td><td class="mdescRight">Lock a system-wide name for this process. <a href="#a1564016ea1fc36677921739d0307f937">More...</a><br/></td></tr>
<tr class="separator:a1564016ea1fc36677921739d0307f937"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb828f1455df52d734b940c7ba8507d2"><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 class="memdesc:afb828f1455df52d734b940c7ba8507d2"><td class="mdescLeft"> </td><td class="mdescRight">Release an acquired lock. <a href="#afb828f1455df52d734b940c7ba8507d2">More...</a><br/></td></tr>
<tr class="separator:afb828f1455df52d734b940c7ba8507d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4172440e8c67b7c2b3e6646c3186d4c2"><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 class="memdesc:a4172440e8c67b7c2b3e6646c3186d4c2"><td class="mdescLeft"> </td><td class="mdescRight">Flag if the current process has aqcuired a lock. <a href="#a4172440e8c67b7c2b3e6646c3186d4c2">More...</a><br/></td></tr>
<tr class="separator:a4172440e8c67b7c2b3e6646c3186d4c2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><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="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> System-wide named lock </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a650710f23bf875e3ea52ae95b2239d74"></a>
<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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>of system-wide lock to create. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8b743f029d010f77ce1d438c603005e7"></a>
<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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ost::Lockfile::~Lockfile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the current lock and release it. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4172440e8c67b7c2b3e6646c3186d4c2"></a>
<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="section return"><dt>Returns</dt><dd>true if we have the lock. </dd></dl>
</div>
</div>
<a class="anchor" id="a1564016ea1fc36677921739d0307f937"></a>
<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="section return"><dt>Returns</dt><dd>true if lock successful. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>system-wide lock to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afb828f1455df52d734b940c7ba8507d2"></a>
<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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
