ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6e4b4ad064564d5fe2e166d04d113d603ddab3f9
rippled/classripple_1_1spinlock.html
nbougalis 70c2d3809d deploy: 83faf43140
2022-07-19 15:12:23 +00:00

298 lines
15 KiB
HTML
Raw Blame History

<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::spinlock&lt; T &gt; Class Template 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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1spinlock.html">spinlock</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1spinlock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::spinlock&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A spinlock implemented on top of an atomic integer.
<a href="classripple_1_1spinlock.html#details">More...</a></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:a20d16e13b4586293281bcfeb06abe834"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1spinlock.html#a20d16e13b4586293281bcfeb06abe834">spinlock</a> (<a class="el" href="classripple_1_1spinlock.html">spinlock</a> const &amp;)=delete</td></tr>
<tr class="separator:a20d16e13b4586293281bcfeb06abe834"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7545a4bdd8c072d3841a8655560be575"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1spinlock.html">spinlock</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1spinlock.html#a7545a4bdd8c072d3841a8655560be575">operator=</a> (<a class="el" href="classripple_1_1spinlock.html">spinlock</a> const &amp;)=delete</td></tr>
<tr class="separator:a7545a4bdd8c072d3841a8655560be575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7541682f7281ab8d2ce12941923fc41"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1spinlock.html#ad7541682f7281ab8d2ce12941923fc41">spinlock</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; T &gt; &amp;<a class="el" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8">lock</a>)</td></tr>
<tr class="memdesc:ad7541682f7281ab8d2ce12941923fc41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Grabs the. <a href="classripple_1_1spinlock.html#ad7541682f7281ab8d2ce12941923fc41">More...</a><br /></td></tr>
<tr class="separator:ad7541682f7281ab8d2ce12941923fc41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35d745b9bf6cb4a53fed73e0b6468a8b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1spinlock.html#a35d745b9bf6cb4a53fed73e0b6468a8b">try_lock</a> ()</td></tr>
<tr class="separator:a35d745b9bf6cb4a53fed73e0b6468a8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48794dec2a00dfb965568163ffdfe0b8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8">lock</a> ()</td></tr>
<tr class="separator:a48794dec2a00dfb965568163ffdfe0b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a039c6e7ea6986a10c5b846411d6b7d21"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1spinlock.html#a039c6e7ea6986a10c5b846411d6b7d21">unlock</a> ()</td></tr>
<tr class="separator:a039c6e7ea6986a10c5b846411d6b7d21"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a2da794f4f35024506fcfbf754c68fc95"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; T &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a></td></tr>
<tr class="separator:a2da794f4f35024506fcfbf754c68fc95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br />
class ripple::spinlock&lt; T &gt;</h3>
<p>A spinlock implemented on top of an atomic integer. </p>
<dl class="section note"><dt>Note</dt><dd>Using <code><a class="el" href="classripple_1_1packed__spinlock.html" title="Classes to handle arrays of spinlocks packed into a single atomic integer:">packed_spinlock</a></code> and <code>spinlock</code> against the same underlying atomic integer can result in <code>spinlock</code> not being able to actually acquire the lock during periods of high contention, because of how the two locks operate: <code>spinlock</code> will spin trying to grab all the bits at once, whereas any given <code><a class="el" href="classripple_1_1packed__spinlock.html" title="Classes to handle arrays of spinlocks packed into a single atomic integer:">packed_spinlock</a></code> will only try to grab one bit at a time. Caveat emptor.</dd></dl>
<p>This class meets the requirements of Lockable: <a href="https://en.cppreference.com/w/cpp/named_req/Lockable">https://en.cppreference.com/w/cpp/named_req/Lockable</a> </p>
<p class="definition">Definition at line <a class="el" href="spinlock_8h_source.html#l00163">163</a> of file <a class="el" href="spinlock_8h_source.html">spinlock.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a20d16e13b4586293281bcfeb06abe834"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20d16e13b4586293281bcfeb06abe834">&#9670;&nbsp;</a></span>spinlock() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1spinlock.html">ripple::spinlock</a>&lt; T &gt;::<a class="el" href="classripple_1_1spinlock.html">spinlock</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1spinlock.html">spinlock</a>&lt; T &gt; const &amp;&#160;</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">
</div>
</div>
<a id="ad7541682f7281ab8d2ce12941923fc41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7541682f7281ab8d2ce12941923fc41">&#9670;&nbsp;</a></span>spinlock() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1spinlock.html">ripple::spinlock</a>&lt; T &gt;::<a class="el" href="classripple_1_1spinlock.html">spinlock</a> </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>lock</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Grabs the. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lock</td><td>The atomic integer to spin against.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>For performance reasons, you should strive to have <code>lock</code> be on a cacheline by itself. </dd></dl>
<p class="definition">Definition at line <a class="el" href="spinlock_8h_source.html#l00183">183</a> of file <a class="el" href="spinlock_8h_source.html">spinlock.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7545a4bdd8c072d3841a8655560be575"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7545a4bdd8c072d3841a8655560be575">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1spinlock.html">spinlock</a>&amp; <a class="el" href="classripple_1_1spinlock.html">ripple::spinlock</a>&lt; T &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1spinlock.html">spinlock</a>&lt; T &gt; const &amp;&#160;</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">
</div>
</div>
<a id="a35d745b9bf6cb4a53fed73e0b6468a8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35d745b9bf6cb4a53fed73e0b6468a8b">&#9670;&nbsp;</a></span>try_lock()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1spinlock.html">ripple::spinlock</a>&lt; T &gt;::try_lock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spinlock_8h_source.html#l00188">188</a> of file <a class="el" href="spinlock_8h_source.html">spinlock.h</a>.</p>
</div>
</div>
<a id="a48794dec2a00dfb965568163ffdfe0b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48794dec2a00dfb965568163ffdfe0b8">&#9670;&nbsp;</a></span>lock()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1spinlock.html">ripple::spinlock</a>&lt; T &gt;::lock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spinlock_8h_source.html#l00200">200</a> of file <a class="el" href="spinlock_8h_source.html">spinlock.h</a>.</p>
</div>
</div>
<a id="a039c6e7ea6986a10c5b846411d6b7d21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a039c6e7ea6986a10c5b846411d6b7d21">&#9670;&nbsp;</a></span>unlock()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1spinlock.html">ripple::spinlock</a>&lt; T &gt;::unlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spinlock_8h_source.html#l00214">214</a> of file <a class="el" href="spinlock_8h_source.html">spinlock.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2da794f4f35024506fcfbf754c68fc95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2da794f4f35024506fcfbf754c68fc95">&#9670;&nbsp;</a></span>lock_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt;T&gt;&amp; <a class="el" href="classripple_1_1spinlock.html">ripple::spinlock</a>&lt; T &gt;::lock_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spinlock_8h_source.html#l00165">165</a> of file <a class="el" href="spinlock_8h_source.html">spinlock.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink