147 lines
7.2 KiB
HTML
147 lines
7.2 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.10.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>stdex: stdex::spinlock 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="cookie.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">stdex
|
|
</div>
|
|
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.10.0 -->
|
|
<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');
|
|
$(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"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1spinlock.html">spinlock</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classstdex_1_1spinlock-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">stdex::spinlock Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Spin-lock.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="spinlock_8hpp_source.html">stdex/spinlock.hpp</a>></code></p>
|
|
<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:a97a72eaa96c16661bb6e268f7d5f0788" id="r_a97a72eaa96c16661bb6e268f7d5f0788"><td class="memItemLeft" align="right" valign="top"><a id="a97a72eaa96c16661bb6e268f7d5f0788" name="a97a72eaa96c16661bb6e268f7d5f0788"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>lock</b> () noexcept</td></tr>
|
|
<tr class="memdesc:a97a72eaa96c16661bb6e268f7d5f0788"><td class="mdescLeft"> </td><td class="mdescRight">Blocks until a lock can be acquired for the current execution agent (thread, process, task). <br /></td></tr>
|
|
<tr class="separator:a97a72eaa96c16661bb6e268f7d5f0788"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47aca0d4a40922892035d7f18dee8f32" id="r_a47aca0d4a40922892035d7f18dee8f32"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a47aca0d4a40922892035d7f18dee8f32">try_lock</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a47aca0d4a40922892035d7f18dee8f32"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to acquire the lock for the current execution agent (thread, process, task) without blocking. <br /></td></tr>
|
|
<tr class="separator:a47aca0d4a40922892035d7f18dee8f32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabdcf0cbe80a8eb5b68f656fb587d74a" id="r_aabdcf0cbe80a8eb5b68f656fb587d74a"><td class="memItemLeft" align="right" valign="top"><a id="aabdcf0cbe80a8eb5b68f656fb587d74a" name="aabdcf0cbe80a8eb5b68f656fb587d74a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>unlock</b> () noexcept</td></tr>
|
|
<tr class="memdesc:aabdcf0cbe80a8eb5b68f656fb587d74a"><td class="mdescLeft"> </td><td class="mdescRight">Releases the non-shared lock held by the execution agent. <br /></td></tr>
|
|
<tr class="separator:aabdcf0cbe80a8eb5b68f656fb587d74a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Spin-lock. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="https://rigtorp.se/spinlock/">Correctly implementing a spinlock in C++</a> </dd></dl>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a47aca0d4a40922892035d7f18dee8f32" name="a47aca0d4a40922892035d7f18dee8f32"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a47aca0d4a40922892035d7f18dee8f32">◆ </a></span>try_lock()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool stdex::spinlock::try_lock </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"></span></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>Attempts to acquire the lock for the current execution agent (thread, process, task) without blocking. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the lock was acquired, false otherwise </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/stdex/<a class="el" href="spinlock_8hpp_source.html">spinlock.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Jan 24 2024 18:00:27 for stdex by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
|
|
</small></address>
|
|
</body>
|
|
</html>
|