<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfilezilla: condition 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectlogo"><img alt="Logo" src="libfilezilla.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfilezilla
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacefz.html">fz</a></li><li class="navelem"><a class="el" href="classfz_1_1condition.html">condition</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classfz_1_1condition-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">condition Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Waitable condition variable.
<a href="classfz_1_1condition.html#details">More...</a></p>
<p><code>#include <<a class="el" href="mutex_8hpp_source.html">mutex.hpp</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:ae941a963426aa192cfb686cc970b8284"><td class="memItemLeft" align="right" valign="top"><a id="ae941a963426aa192cfb686cc970b8284"></a>
 </td><td class="memItemRight" valign="bottom"><b>condition</b> (<a class="el" href="classfz_1_1condition.html">condition</a> const &)=delete</td></tr>
<tr class="separator:ae941a963426aa192cfb686cc970b8284"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8a9fd12adc0875293a946295679e235"><td class="memItemLeft" align="right" valign="top"><a id="ab8a9fd12adc0875293a946295679e235"></a>
<a class="el" href="classfz_1_1condition.html">condition</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfz_1_1condition.html">condition</a> const &)=delete</td></tr>
<tr class="separator:ab8a9fd12adc0875293a946295679e235"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d557df085bb788b92afe06ad00423c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1condition.html#a1d557df085bb788b92afe06ad00423c7">wait</a> (<a class="el" href="classfz_1_1scoped__lock.html">scoped_lock</a> &l)</td></tr>
<tr class="memdesc:a1d557df085bb788b92afe06ad00423c7"><td class="mdescLeft"> </td><td class="mdescRight">Wait indefinitely for condition to become signalled. <a href="#a1d557df085bb788b92afe06ad00423c7">More...</a><br /></td></tr>
<tr class="separator:a1d557df085bb788b92afe06ad00423c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dc0d62e7ad099046d2e290368a188d5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1condition.html#a5dc0d62e7ad099046d2e290368a188d5">wait</a> (<a class="el" href="classfz_1_1scoped__lock.html">scoped_lock</a> &l, <a class="el" href="classfz_1_1duration.html">duration</a> const &timeout)</td></tr>
<tr class="memdesc:a5dc0d62e7ad099046d2e290368a188d5"><td class="mdescLeft"> </td><td class="mdescRight">Wait until timeout for condition to become signalled. <a href="#a5dc0d62e7ad099046d2e290368a188d5">More...</a><br /></td></tr>
<tr class="separator:a5dc0d62e7ad099046d2e290368a188d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93f86ef1fc563f47689777cb987b3b2b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1condition.html#a93f86ef1fc563f47689777cb987b3b2b">signal</a> (<a class="el" href="classfz_1_1scoped__lock.html">scoped_lock</a> &l)</td></tr>
<tr class="memdesc:a93f86ef1fc563f47689777cb987b3b2b"><td class="mdescLeft"> </td><td class="mdescRight">Signal condition variable. <a href="#a93f86ef1fc563f47689777cb987b3b2b">More...</a><br /></td></tr>
<tr class="separator:a93f86ef1fc563f47689777cb987b3b2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b4ab8fe486bc9ef51f74cf206c7dde0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1condition.html#a8b4ab8fe486bc9ef51f74cf206c7dde0">signalled</a> (<a class="el" href="classfz_1_1scoped__lock.html">scoped_lock</a> const &) const</td></tr>
<tr class="memdesc:a8b4ab8fe486bc9ef51f74cf206c7dde0"><td class="mdescLeft"> </td><td class="mdescRight">Check if condition is already signalled. <a href="#a8b4ab8fe486bc9ef51f74cf206c7dde0">More...</a><br /></td></tr>
<tr class="separator:a8b4ab8fe486bc9ef51f74cf206c7dde0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Waitable condition variable. </p>
<p>Allows one thread to wait for the condition variable to become signalled by another thread. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="events_8cpp-example.html#_a0">events.cpp</a>.</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a93f86ef1fc563f47689777cb987b3b2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93f86ef1fc563f47689777cb987b3b2b">◆ </a></span>signal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void signal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classfz_1_1scoped__lock.html">scoped_lock</a> & </td>
<td class="paramname"><em>l</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal condition variable. </p>
<p>To avoid race conditions leading to lost signals, you must pass a locked mutex.</p>
<dl class="section note"><dt>Note</dt><dd>Spurious signals are a rare possibility.</dd>
<dd>
The lock must have be on the same mutex that is used for both signalling and for waiting. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="events_8cpp-example.html#a9">events.cpp</a>.</dd>
</dl>
</div>
</div>
<a id="a8b4ab8fe486bc9ef51f74cf206c7dde0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b4ab8fe486bc9ef51f74cf206c7dde0">◆ </a></span>signalled()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool signalled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classfz_1_1scoped__lock.html">scoped_lock</a> const & </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if condition is already signalled. </p>
<p>To avoid race conditions leading to lost signals, you must pass a locked mutex.</p>
<dl class="section note"><dt>Note</dt><dd>The lock must have be on the same mutex that is used for both signalling and for waiting. </dd></dl>
</div>
</div>
<a id="a1d557df085bb788b92afe06ad00423c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d557df085bb788b92afe06ad00423c7">◆ </a></span>wait() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classfz_1_1scoped__lock.html">scoped_lock</a> & </td>
<td class="paramname"><em>l</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait indefinitely for condition to become signalled. </p>
<p>Atomically unlocks the mutex and waits for the condition. Atomically consumes the signal and re-locks the mutex.</p>
<dl class="section note"><dt>Note</dt><dd>The lock must have be on the same mutex that is used for both signalling and for waiting. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="events_8cpp-example.html#a10">events.cpp</a>.</dd>
</dl>
</div>
</div>
<a id="a5dc0d62e7ad099046d2e290368a188d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dc0d62e7ad099046d2e290368a188d5">◆ </a></span>wait() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classfz_1_1scoped__lock.html">scoped_lock</a> & </td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classfz_1_1duration.html">duration</a> const & </td>
<td class="paramname"><em>timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait until timeout for condition to become signalled. </p>
<p>Atomically unlocks the mutex and waits for the condition. Atomically consumes the signal and re-locks the mutex.</p>
<dl class="section return"><dt>Returns</dt><dd>true if the condition has been signalled. </dd>
<dd>
false if the condition could not be obtained before the timeout has elapsed.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Spurious signals are a rare possibility.</dd>
<dd>
The lock must have be on the same mutex that is used for both signalling and for waiting. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mutex_8hpp_source.html">mutex.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
94774a05d4f99367afd97b8b4adf565d
>
files
>
89
