<!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.4"/>
<title>c++-gtk-utils: Cgu::Thread::Mutex::TrackLock 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">c++-gtk-utils
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</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="namespaceCgu.html">Cgu</a></li><li class="navelem"><a class="el" href="namespaceCgu_1_1Thread.html">Thread</a></li><li class="navelem"><a class="el" href="classCgu_1_1Thread_1_1Mutex.html">Mutex</a></li><li class="navelem"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html">TrackLock</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Cgu::Thread::Mutex::TrackLock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A scoped locking class for exception safe <a class="el" href="classCgu_1_1Thread_1_1Mutex.html" title="A wrapper class for pthread mutexes. ">Mutex</a> locking which tracks the status of its mutex.
<a href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#details">More...</a></p>
<p><code>#include <<a class="el" href="mutex_8h_source.html">c++-gtk-utils/mutex.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:a214880bace001d9605c6a22a5f2e7d78"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a214880bace001d9605c6a22a5f2e7d78">TrackLock</a> (const <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html">Mutex::TrackLock</a> &)=delete</td></tr>
<tr class="separator:a214880bace001d9605c6a22a5f2e7d78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cd0bbe6c4e2a9d425f6589d5980a205"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html">Mutex::TrackLock</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a6cd0bbe6c4e2a9d425f6589d5980a205">operator=</a> (const <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html">Mutex::TrackLock</a> &)=delete</td></tr>
<tr class="separator:a6cd0bbe6c4e2a9d425f6589d5980a205"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa475b3625f67c6c18173ab6696f94c24"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#aa475b3625f67c6c18173ab6696f94c24">lock</a> () noexcept</td></tr>
<tr class="separator:aa475b3625f67c6c18173ab6696f94c24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c0a9c94d09921419cbdc0c40bc53a8e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a7c0a9c94d09921419cbdc0c40bc53a8e">trylock</a> () noexcept</td></tr>
<tr class="separator:a7c0a9c94d09921419cbdc0c40bc53a8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70b7063c7fd361dd8a260ffb1fc51ba0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a70b7063c7fd361dd8a260ffb1fc51ba0">unlock</a> () noexcept</td></tr>
<tr class="separator:a70b7063c7fd361dd8a260ffb1fc51ba0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a703f2658db1d8f3972267981161139"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a8a703f2658db1d8f3972267981161139">is_owner</a> () const noexcept</td></tr>
<tr class="separator:a8a703f2658db1d8f3972267981161139"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac31df9d12d6e5b89c8ef91a224fa117d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#ac31df9d12d6e5b89c8ef91a224fa117d">TrackLock</a> (<a class="el" href="classCgu_1_1Thread_1_1Mutex.html">Mutex</a> &mutex_) noexcept</td></tr>
<tr class="separator:ac31df9d12d6e5b89c8ef91a224fa117d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af03894b907e277c810ae98ba3deba734"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#af03894b907e277c810ae98ba3deba734">TrackLock</a> (<a class="el" href="classCgu_1_1Thread_1_1Mutex.html">Mutex</a> &mutex_, <a class="el" href="namespaceCgu_1_1Thread.html#ae859cc661aefb3465ab878a3f7305910">Locked</a> tag) noexcept</td></tr>
<tr class="separator:af03894b907e277c810ae98ba3deba734"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e93fdeb0cde2e98b64f0fd1faaaa4f2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a4e93fdeb0cde2e98b64f0fd1faaaa4f2">TrackLock</a> (<a class="el" href="classCgu_1_1Thread_1_1Mutex.html">Mutex</a> &mutex_, <a class="el" href="namespaceCgu_1_1Thread.html#a805d60a9ddc5469f5d1cde5451670af7">DeferLock</a> tag) noexcept</td></tr>
<tr class="separator:a4e93fdeb0cde2e98b64f0fd1faaaa4f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab368fbc7ab0f3f31e9d34b681fea51fd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#ab368fbc7ab0f3f31e9d34b681fea51fd">TrackLock</a> ()=delete</td></tr>
<tr class="separator:ab368fbc7ab0f3f31e9d34b681fea51fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adbafa3fe71d705aaccd873c96cc1886e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#adbafa3fe71d705aaccd873c96cc1886e">~TrackLock</a> ()</td></tr>
<tr class="separator:adbafa3fe71d705aaccd873c96cc1886e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a7b3a3b08a18ec6e57d9a2f52744212c4"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a7b3a3b08a18ec6e57d9a2f52744212c4">Cond</a></td></tr>
<tr class="separator:a7b3a3b08a18ec6e57d9a2f52744212c4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A scoped locking class for exception safe <a class="el" href="classCgu_1_1Thread_1_1Mutex.html" title="A wrapper class for pthread mutexes. ">Mutex</a> locking which tracks the status of its mutex. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classCgu_1_1Thread_1_1Mutex.html" title="A wrapper class for pthread mutexes. ">Thread::Mutex</a> <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1Lock.html" title="A scoped locking class for exception safe Mutex locking. ">Thread::Mutex::Lock</a> <a class="el" href="classCgu_1_1Thread_1_1Thread.html" title="A class representing a pthread thread. ">Thread::Thread</a> <a class="el" href="classCgu_1_1Thread_1_1Cond.html" title="A wrapper class for pthread condition variables. ">Thread::Cond</a></dd></dl>
<p>This class is similar to a <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1Lock.html" title="A scoped locking class for exception safe Mutex locking. ">Mutex::Lock</a> object, except that it tracks whether the mutex it manages is locked by the thread creating the <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html" title="A scoped locking class for exception safe Mutex locking which tracks the status of its mutex...">Mutex::TrackLock</a> object (provided that, while the <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html" title="A scoped locking class for exception safe Mutex locking which tracks the status of its mutex...">Mutex::TrackLock</a> object exists, the thread creating it only accesses the mutex through that object). This enables <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a70b7063c7fd361dd8a260ffb1fc51ba0">Mutex::TrackLock::unlock()</a> to be used without it being followed later by a call to <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#aa475b3625f67c6c18173ab6696f94c24">Mutex::TrackLock::lock()</a> or a successful call to <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a7c0a9c94d09921419cbdc0c40bc53a8e">Mutex::TrackLock::trylock()</a>, and also permits locking to be deferred until after construction of the lock object. Note that only one thread may call the methods of any one <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html" title="A scoped locking class for exception safe Mutex locking which tracks the status of its mutex...">Mutex::TrackLock</a> object, including causing its destructor to be invoked. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a214880bace001d9605c6a22a5f2e7d78"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Cgu::Thread::Mutex::TrackLock::TrackLock </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html">Mutex::TrackLock</a> & </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This class cannot be copied. The copy constructor is deleted. </p>
</div>
</div>
<a class="anchor" id="ac31df9d12d6e5b89c8ef91a224fa117d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Cgu::Thread::Mutex::TrackLock::TrackLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCgu_1_1Thread_1_1Mutex.html">Mutex</a> & </td>
<td class="paramname"><em>mutex_</em>)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This constructor locks the mutex passed to it. It is not a cancellation point. It does not throw. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex_</td><td>The mutex to be locked. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af03894b907e277c810ae98ba3deba734"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Cgu::Thread::Mutex::TrackLock::TrackLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCgu_1_1Thread_1_1Mutex.html">Mutex</a> & </td>
<td class="paramname"><em>mutex_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceCgu_1_1Thread.html#ae859cc661aefb3465ab878a3f7305910">Locked</a> </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This constructor takes an already locked mutex (say as a result of <a class="el" href="classCgu_1_1Thread_1_1Mutex.html#af19346cf724ffdc508f5fe54889e57a0">Mutex::trylock()</a>), and takes ownership of it. It is not a cancellation point. It does not throw. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex_</td><td>The mutex to be managed by this object. </td></tr>
<tr><td class="paramname">tag</td><td>Pass the <a class="el" href="namespaceCgu_1_1Thread.html#ae859cc661aefb3465ab878a3f7305910a852f8168e5f00130c64125b059109a35">Cgu::Thread::locked</a> enum tag to this parameter. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4e93fdeb0cde2e98b64f0fd1faaaa4f2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Cgu::Thread::Mutex::TrackLock::TrackLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCgu_1_1Thread_1_1Mutex.html">Mutex</a> & </td>
<td class="paramname"><em>mutex_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceCgu_1_1Thread.html#a805d60a9ddc5469f5d1cde5451670af7">DeferLock</a> </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This constructor defers locking of the mutex (and so taking ownership of it) until an explicit call to <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#aa475b3625f67c6c18173ab6696f94c24">lock()</a> or <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a7c0a9c94d09921419cbdc0c40bc53a8e">trylock()</a> is made. It is not a cancellation point. It does not throw. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex_</td><td>The mutex to be managed by this object. </td></tr>
<tr><td class="paramname">tag</td><td>Pass the <a class="el" href="namespaceCgu_1_1Thread.html#a805d60a9ddc5469f5d1cde5451670af7aeca263f786f779ee077c1880c8627546">Cgu::Thread::defer</a> enum tag to this parameter. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab368fbc7ab0f3f31e9d34b681fea51fd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Cgu::Thread::Mutex::TrackLock::TrackLock </td>
<td>(</td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This class requires initialisation with a <a class="el" href="classCgu_1_1Thread_1_1Mutex.html" title="A wrapper class for pthread mutexes. ">Mutex</a>. The default constructor is deleted. </p>
</div>
</div>
<a class="anchor" id="adbafa3fe71d705aaccd873c96cc1886e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Cgu::Thread::Mutex::TrackLock::~TrackLock </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>The destructor unlocks the managed mutex if it is locked. It is not a cancellation point. It does not throw. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8a703f2658db1d8f3972267981161139"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Cgu::Thread::Mutex::TrackLock::is_owner </td>
<td>(</td>
<td class="paramname">)</td><td></td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether the mutex managed by this <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html" title="A scoped locking class for exception safe Mutex locking which tracks the status of its mutex...">Mutex::TrackLock</a> object is locked, and so owned, by it. It does not throw. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the mutex is locked by this object, otherwise false. </dd></dl>
</div>
</div>
<a class="anchor" id="aa475b3625f67c6c18173ab6696f94c24"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Cgu::Thread::Mutex::TrackLock::lock </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calls <a class="el" href="classCgu_1_1Thread_1_1Mutex.html#a4117ae4f42f0972dcd286d2cbb7e014c">Mutex::lock()</a>, and so locks the mutex and acquires ownership. It blocks if the mutex is already locked until the mutex becomes free. This method should normally only be called if a previous call has been made to <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a70b7063c7fd361dd8a260ffb1fc51ba0">Mutex::TrackLock::unlock()</a> or this <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html" title="A scoped locking class for exception safe Mutex locking which tracks the status of its mutex...">Mutex::TrackLock</a> object has been constructed with the <a class="el" href="namespaceCgu_1_1Thread.html#a805d60a9ddc5469f5d1cde5451670af7aeca263f786f779ee077c1880c8627546">Thread::defer</a> enum tag. It is not a cancellation point. It does not throw. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, otherwise the pthread mutex error number. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>With this library implementation, the only pthread error number which could be returned by this method is EDEADLK, which it would do if the default pthread mutex behaviour happens to return that error rather than deadlock in the case of recursive locking. Most default implementations do not do this and hence the return value is usually not worth checking for except during debugging. </dd></dl>
</div>
</div>
<a class="anchor" id="a6cd0bbe6c4e2a9d425f6589d5980a205"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html">Mutex::TrackLock</a>& Cgu::Thread::Mutex::TrackLock::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html">Mutex::TrackLock</a> & </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This class cannot be copied. The assignment operator is deleted. </p>
</div>
</div>
<a class="anchor" id="a7c0a9c94d09921419cbdc0c40bc53a8e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Cgu::Thread::Mutex::TrackLock::trylock </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calls <a class="el" href="classCgu_1_1Thread_1_1Mutex.html#af19346cf724ffdc508f5fe54889e57a0">Mutex::trylock()</a>, and so tries to lock the mutex and acquire ownership, but returns immediately if it is already locked with value EBUSY. This method should normally only be called if a previous call has been made to <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a70b7063c7fd361dd8a260ffb1fc51ba0">Mutex::TrackLock::unlock()</a> or this <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html" title="A scoped locking class for exception safe Mutex locking which tracks the status of its mutex...">Mutex::TrackLock</a> object has been constructed with the <a class="el" href="namespaceCgu_1_1Thread.html#a805d60a9ddc5469f5d1cde5451670af7aeca263f786f779ee077c1880c8627546">Thread::defer</a> enum tag. It is not a cancellation point. It does not throw. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, otherwise EBUSY. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>With this library implementation, the only pthread error number which could be returned by this method is EBUSY. </dd></dl>
</div>
</div>
<a class="anchor" id="a70b7063c7fd361dd8a260ffb1fc51ba0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Cgu::Thread::Mutex::TrackLock::unlock </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calls <a class="el" href="classCgu_1_1Thread_1_1Mutex.html#ade61c52c94dd0ddbea64fe434708ac37">Mutex::unlock()</a>, and so unlocks a locked mutex owned by the calling thread. It will cause <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a8a703f2658db1d8f3972267981161139">is_owner()</a> to return false unless a subsequent call is made to <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#aa475b3625f67c6c18173ab6696f94c24">lock()</a> or a subsequent successful call is made to <a class="el" href="classCgu_1_1Thread_1_1Mutex_1_1TrackLock.html#a7c0a9c94d09921419cbdc0c40bc53a8e">trylock()</a>. It is not a cancellation point. It does not throw. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, otherwise the pthread mutex error number. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>With this library implementation, the only pthread error number which could be returned by this method is EPERM because the calling thread does not own the mutex (however POSIX does not require that return value in that case and hence the return value is usually not worth checking for except during debugging). </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a7b3a3b08a18ec6e57d9a2f52744212c4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classCgu_1_1Thread_1_1Cond.html">Cond</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mutex_8h_source.html">mutex.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 16 2013 20:45:32 for c++-gtk-utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
