215 lines
14 KiB
HTML
215 lines
14 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::rwlock 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_1rwlock.html">rwlock</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classuvw_1_1rwlock-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">uvw::rwlock Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The rwlock wrapper.
|
|
<a href="classuvw_1_1rwlock.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::rwlock:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classuvw_1_1rwlock__inherit__graph.png" border="0" usemap="#auvw_1_1rwlock_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="auvw_1_1rwlock_inherit__map" id="auvw_1_1rwlock_inherit__map">
|
|
<area shape="rect" title="The rwlock wrapper." alt="" coords="55,79,143,104"/>
|
|
<area shape="rect" href="structuvw_1_1uv__type.html" title=" " alt="" coords="5,5,192,31"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for uvw::rwlock:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classuvw_1_1rwlock__coll__graph.png" border="0" usemap="#auvw_1_1rwlock_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="auvw_1_1rwlock_coll__map" id="auvw_1_1rwlock_coll__map">
|
|
<area shape="rect" title="The rwlock wrapper." alt="" coords="55,79,143,104"/>
|
|
<area shape="rect" href="structuvw_1_1uv__type.html" title=" " alt="" coords="5,5,192,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:a48a2f73a53caecad83f82544bce5e754"><td class="memItemLeft" align="right" valign="top"><a id="a48a2f73a53caecad83f82544bce5e754" name="a48a2f73a53caecad83f82544bce5e754"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>rdlock</b> () noexcept</td></tr>
|
|
<tr class="memdesc:a48a2f73a53caecad83f82544bce5e754"><td class="mdescLeft"> </td><td class="mdescRight">Locks a read-write lock object for reading. <br /></td></tr>
|
|
<tr class="separator:a48a2f73a53caecad83f82544bce5e754"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a51e06cdde0ef98fcfd43d81db1cadf23"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1rwlock.html#a51e06cdde0ef98fcfd43d81db1cadf23">try_rdlock</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a51e06cdde0ef98fcfd43d81db1cadf23"><td class="mdescLeft"> </td><td class="mdescRight">Tries to lock a read-write lock object for reading. <br /></td></tr>
|
|
<tr class="separator:a51e06cdde0ef98fcfd43d81db1cadf23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab5fb7747eddb48d8ff88d0ab266d9ef1"><td class="memItemLeft" align="right" valign="top"><a id="ab5fb7747eddb48d8ff88d0ab266d9ef1" name="ab5fb7747eddb48d8ff88d0ab266d9ef1"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>rdunlock</b> () noexcept</td></tr>
|
|
<tr class="memdesc:ab5fb7747eddb48d8ff88d0ab266d9ef1"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks a read-write lock object previously locked for reading. <br /></td></tr>
|
|
<tr class="separator:ab5fb7747eddb48d8ff88d0ab266d9ef1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacd6baeb68d2178665ce5bf331a4fd0a"><td class="memItemLeft" align="right" valign="top"><a id="aacd6baeb68d2178665ce5bf331a4fd0a" name="aacd6baeb68d2178665ce5bf331a4fd0a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>wrlock</b> () noexcept</td></tr>
|
|
<tr class="memdesc:aacd6baeb68d2178665ce5bf331a4fd0a"><td class="mdescLeft"> </td><td class="mdescRight">Locks a read-write lock object for writing. <br /></td></tr>
|
|
<tr class="separator:aacd6baeb68d2178665ce5bf331a4fd0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6692bdc0b55fe3416364ade16f53eff1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1rwlock.html#a6692bdc0b55fe3416364ade16f53eff1">try_wrlock</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a6692bdc0b55fe3416364ade16f53eff1"><td class="mdescLeft"> </td><td class="mdescRight">Tries to lock a read-write lock object for writing. <br /></td></tr>
|
|
<tr class="separator:a6692bdc0b55fe3416364ade16f53eff1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24419f230f193655cda30eafaf0f3070"><td class="memItemLeft" align="right" valign="top"><a id="a24419f230f193655cda30eafaf0f3070" name="a24419f230f193655cda30eafaf0f3070"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>wrunlock</b> () noexcept</td></tr>
|
|
<tr class="memdesc:a24419f230f193655cda30eafaf0f3070"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks a read-write lock object previously locked for writing. <br /></td></tr>
|
|
<tr class="separator:a24419f230f193655cda30eafaf0f3070"><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_rwlock_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_rwlock_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_rwlock_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 rwlock wrapper. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="thread_8h_source.html#l00211">211</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="a51e06cdde0ef98fcfd43d81db1cadf23" name="a51e06cdde0ef98fcfd43d81db1cadf23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51e06cdde0ef98fcfd43d81db1cadf23">◆ </a></span>try_rdlock()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool uvw::rwlock::try_rdlock </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>Tries to lock a read-write lock object for reading. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6692bdc0b55fe3416364ade16f53eff1" name="a6692bdc0b55fe3416364ade16f53eff1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6692bdc0b55fe3416364ade16f53eff1">◆ </a></span>try_wrlock()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool uvw::rwlock::try_wrlock </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>Tries to lock a read-write lock object for writing. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </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>
|