Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / classdmlc_1_1Spinlock.html
blob: 8f6e8afef8d3cc2d0c1b868203dc0623376ef479 [file] [log] [blame]
<!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>mxnet: dmlc::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>
<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">mxnet
</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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_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="classdmlc_1_1Spinlock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::Spinlock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Simple userspace spinlock implementation.
<a href="classdmlc_1_1Spinlock.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="concurrency_8h_source.html">concurrency.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for dmlc::Spinlock:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1Spinlock__coll__graph.png" border="0" usemap="#dmlc_1_1Spinlock_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</div>
<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:a0a84833ade90ba85e17219a6c892cfec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Spinlock.html#a0a84833ade90ba85e17219a6c892cfec">Spinlock</a> ()</td></tr>
<tr class="separator:a0a84833ade90ba85e17219a6c892cfec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f7f0b06965a3d5ee97cca39b33b72a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Spinlock.html#a7f7f0b06965a3d5ee97cca39b33b72a8">~Spinlock</a> ()=default</td></tr>
<tr class="separator:a7f7f0b06965a3d5ee97cca39b33b72a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac18746d90b20c0cef20c3443f448adf8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Spinlock.html#ac18746d90b20c0cef20c3443f448adf8">lock</a> () noexcept(true)</td></tr>
<tr class="memdesc:ac18746d90b20c0cef20c3443f448adf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquire lock. <a href="classdmlc_1_1Spinlock.html#ac18746d90b20c0cef20c3443f448adf8">More...</a><br /></td></tr>
<tr class="separator:ac18746d90b20c0cef20c3443f448adf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4838f60a973007f28abd5e2eb6a5be8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Spinlock.html#a4838f60a973007f28abd5e2eb6a5be8a">unlock</a> () noexcept(true)</td></tr>
<tr class="memdesc:a4838f60a973007f28abd5e2eb6a5be8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release lock. <a href="classdmlc_1_1Spinlock.html#a4838f60a973007f28abd5e2eb6a5be8a">More...</a><br /></td></tr>
<tr class="separator:a4838f60a973007f28abd5e2eb6a5be8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Simple userspace spinlock implementation. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0a84833ade90ba85e17219a6c892cfec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a84833ade90ba85e17219a6c892cfec">&#9670;&nbsp;</a></span>Spinlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::Spinlock::Spinlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7f7f0b06965a3d5ee97cca39b33b72a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f7f0b06965a3d5ee97cca39b33b72a8">&#9670;&nbsp;</a></span>~Spinlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::Spinlock::~Spinlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac18746d90b20c0cef20c3443f448adf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac18746d90b20c0cef20c3443f448adf8">&#9670;&nbsp;</a></span>lock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::Spinlock::lock </td>
<td>(</td>
<td class="paramname"></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>Acquire lock. </p>
</div>
</div>
<a id="a4838f60a973007f28abd5e2eb6a5be8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4838f60a973007f28abd5e2eb6a5be8a">&#9670;&nbsp;</a></span>unlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::Spinlock::unlock </td>
<td>(</td>
<td class="paramname"></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>Release lock. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="concurrency_8h_source.html">concurrency.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 for mxnet 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>