288 lines
16 KiB
HTML
288 lines
16 KiB
HTML
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uvw: uvw::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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">uvw<span id="projectnumber"> 3.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="classuvw_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="classuvw_1_1condition-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">uvw::condition Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The condition wrapper.
|
|
<a href="classuvw_1_1condition.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="thread_8h_source.html">thread.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for uvw::condition:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classuvw_1_1condition__inherit__graph.png" border="0" usemap="#auvw_1_1condition_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="auvw_1_1condition_inherit__map" id="auvw_1_1condition_inherit__map">
|
|
<area shape="rect" title="The condition wrapper." alt="" coords="43,79,145,104"/>
|
|
<area shape="rect" href="structuvw_1_1uv__type.html" title=" " alt="" coords="5,5,183,31"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for uvw::condition:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classuvw_1_1condition__coll__graph.png" border="0" usemap="#auvw_1_1condition_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="auvw_1_1condition_coll__map" id="auvw_1_1condition_coll__map">
|
|
<area shape="rect" title="The condition wrapper." alt="" coords="43,79,145,104"/>
|
|
<area shape="rect" href="structuvw_1_1uv__type.html" title=" " alt="" coords="5,5,183,31"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a02dfe50d273ed1263c839edb504213a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1condition.html#a02dfe50d273ed1263c839edb504213a0">signal</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a02dfe50d273ed1263c839edb504213a0"><td class="mdescLeft"> </td><td class="mdescRight">Signals a condition. <br /></td></tr>
|
|
<tr class="separator:a02dfe50d273ed1263c839edb504213a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba9e52349e417204c43b2383008ead7a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1condition.html#aba9e52349e417204c43b2383008ead7a">broadcast</a> () noexcept</td></tr>
|
|
<tr class="memdesc:aba9e52349e417204c43b2383008ead7a"><td class="mdescLeft"> </td><td class="mdescRight">Broadcasts a condition. <br /></td></tr>
|
|
<tr class="separator:aba9e52349e417204c43b2383008ead7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49753b61acdfbf76ba87b70d6f441289"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1condition.html#a49753b61acdfbf76ba87b70d6f441289">wait</a> (<a class="el" href="classuvw_1_1mutex.html">mutex</a> &mtx) noexcept</td></tr>
|
|
<tr class="memdesc:a49753b61acdfbf76ba87b70d6f441289"><td class="mdescLeft"> </td><td class="mdescRight">Waits on a condition. <br /></td></tr>
|
|
<tr class="separator:a49753b61acdfbf76ba87b70d6f441289"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1ca0e3ae4854fc8e16068922db667a4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1condition.html#af1ca0e3ae4854fc8e16068922db667a4">timed_wait</a> (<a class="el" href="classuvw_1_1mutex.html">mutex</a> &mtx, uint64_t timeout) noexcept</td></tr>
|
|
<tr class="memdesc:af1ca0e3ae4854fc8e16068922db667a4"><td class="mdescLeft"> </td><td class="mdescRight">Waits on a condition. <br /></td></tr>
|
|
<tr class="separator:af1ca0e3ae4854fc8e16068922db667a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structuvw_1_1uv__type"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structuvw_1_1uv__type')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structuvw_1_1uv__type.html">uvw::uv_type< uv_cond_t ></a></td></tr>
|
|
<tr class="memitem:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae97ffacc0b381610d8d18a62a957a69c">init</a> ()</td></tr>
|
|
<tr class="memdesc:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the handle. <br /></td></tr>
|
|
<tr class="separator:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1loop.html">loop</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae03b0ebbae151c6157c5ba6a24a39a7b">parent</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the loop from which the resource was originated. <br /></td></tr>
|
|
<tr class="separator:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">const uv_cond_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">raw</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
|
|
<tr class="separator:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">uv_cond_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#af4b6f395815f2e99302b5f09be23767c">raw</a> () noexcept</td></tr>
|
|
<tr class="memdesc:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
|
|
<tr class="separator:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The condition wrapper. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="thread_8h_source.html#l00283">283</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aba9e52349e417204c43b2383008ead7a" name="aba9e52349e417204c43b2383008ead7a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba9e52349e417204c43b2383008ead7a">◆ </a></span>broadcast()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void uvw::condition::broadcast </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Broadcasts a condition. </p>
|
|
<p>This function shall unblock threads blocked on a condition variable. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a02dfe50d273ed1263c839edb504213a0" name="a02dfe50d273ed1263c839edb504213a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a02dfe50d273ed1263c839edb504213a0">◆ </a></span>signal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void uvw::condition::signal </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Signals a condition. </p>
|
|
<p>This function shall unblock at least one of the threads that are blocked on the specified condition variable (if any threads are blocked on it). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af1ca0e3ae4854fc8e16068922db667a4" name="af1ca0e3ae4854fc8e16068922db667a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af1ca0e3ae4854fc8e16068922db667a4">◆ </a></span>timed_wait()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool uvw::condition::timed_wait </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classuvw_1_1mutex.html">mutex</a> & </td>
|
|
<td class="paramname"><em>mtx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>timeout</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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Waits on a condition. </p>
|
|
<p>These function atomically releases the mutex and causes the calling thread to block on the condition variable.<br />
|
|
The functions returns with an error if the absolute time specified passes (that is, system time equals or exceeds it) before the condition is signaled or broadcasted, or if the absolute time specified has already been passed at the time of the call.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mtx</td><td>A mutex locked by the calling thread, otherwise expect undefined behavior. </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>The maximum time to wait before to return. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a49753b61acdfbf76ba87b70d6f441289" name="a49753b61acdfbf76ba87b70d6f441289"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49753b61acdfbf76ba87b70d6f441289">◆ </a></span>wait()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void uvw::condition::wait </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classuvw_1_1mutex.html">mutex</a> & </td>
|
|
<td class="paramname"><em>mtx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Waits on a condition. </p>
|
|
<p>These function atomically releases the mutex and causes the calling thread to block on the condition variable.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mtx</td><td>A mutex locked by the calling thread, otherwise expect undefined behavior. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/uvw/<a class="el" href="thread_8h_source.html">thread.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|