tinykernel/docs/html/classtk_1_1_lock_guard.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.18.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tinykernel: tk::LockGuard&lt; Lockable &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="codefolding.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">tinykernel
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.18.0 -->
<script type="text/javascript">
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="application/json" id="doxygen-config">
{
  "relPath": "",
  "generateTreeView": true,
  "searchEngine": true,
  "serverBasedSearch": false,
  "disableIndex": false,
  "dynamicMenus": true,
  "fullSidebar": false
}
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<div id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
  <ul class="sm sm-dox" id="main-menu">
    <li id="searchBoxPos2">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
          </span>
        </div>
    </li>
  </ul>
</div><!-- main-nav -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded',() => { initNavTree('classtk_1_1_lock_guard.html','','classtk_1_1_lock_guard-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow">
</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 class="header">
  <div class="headertitle"><div class="title">tk::LockGuard&lt; Lockable &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p>ミューテックスのロックをスコープ単位で安全に管理する RAII クラス (std::lock_guard 相当)  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="sync_8hpp_source.html">sync.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3a922c7edf84ce25ef67151c322bb0eb" id="r_a3a922c7edf84ce25ef67151c322bb0eb"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a3a922c7edf84ce25ef67151c322bb0eb">LockGuard</a> (Lockable &amp;m)</td></tr>
<tr class="memdesc:a3a922c7edf84ce25ef67151c322bb0eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">ロック対象を受け取り、即座に <a class="el" href="namespacetk.html#a6540aa25eb8562f6d6c8b37977d6cfe8" title="ハードウェアスピンロックと全割り込み禁止によるクリティカルセクションに入ります">lock()</a> します  <br /></td></tr>
<tr class="memitem:a52eeb50abee00bd0ed16cfa6618ce40f" id="r_a52eeb50abee00bd0ed16cfa6618ce40f"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a52eeb50abee00bd0ed16cfa6618ce40f">~LockGuard</a> ()</td></tr>
<tr class="memitem:af9bc86bc2036c4b8e54633ddee811604" id="r_af9bc86bc2036c4b8e54633ddee811604"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#af9bc86bc2036c4b8e54633ddee811604">LockGuard</a> (const LockGuard &amp;)=delete</td></tr>
<tr class="memitem:a3f121f8aa1307f0f6e6e608cf138340c" id="r_a3f121f8aa1307f0f6e6e608cf138340c"><td class="memItemLeft"><a class="el" href="#a3a922c7edf84ce25ef67151c322bb0eb">LockGuard</a> &amp;&#160;</td><td class="memItemRight"><a class="el" href="#a3f121f8aa1307f0f6e6e608cf138340c">operator=</a> (const <a class="el" href="#a3a922c7edf84ce25ef67151c322bb0eb">LockGuard</a> &amp;)=delete</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename Lockable&gt;<br />
class tk::LockGuard&lt; Lockable &gt;</div><p>ミューテックスのロックをスコープ単位で安全に管理する RAII クラス (std::lock_guard 相当) </p>
<p>構築時に <span class="tt"><a class="el" href="namespacetk.html#a6540aa25eb8562f6d6c8b37977d6cfe8" title="ハードウェアスピンロックと全割り込み禁止によるクリティカルセクションに入ります">lock()</a></span> を呼び、デストラクタで自動的に <span class="tt"><a class="el" href="namespacetk.html#a752b12f6862815c94a52347af52578b7" title="tk::lock() で入ったクリティカルセクションを抜けます">unlock()</a></span> を呼び出します。 途中で return や例外が発生しても確実にロックが解放されます。</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Lockable</td><td><a class="el" href="namespacetk.html#a6540aa25eb8562f6d6c8b37977d6cfe8" title="ハードウェアスピンロックと全割り込み禁止によるクリティカルセクションに入ります">lock()</a> と <a class="el" href="namespacetk.html#a752b12f6862815c94a52347af52578b7" title="tk::lock() で入ったクリティカルセクションを抜けます">unlock()</a> を持つ型 (例: <a class="el" href="classtk_1_1_mutex.html" title="所有権・優先度順ウェイクアップ・RAII 対応のミューテックス (排他ロック)">tk::Mutex</a>) </td></tr>
  </table>
  </dd>
</dl>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3a922c7edf84ce25ef67151c322bb0eb" name="a3a922c7edf84ce25ef67151c322bb0eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a922c7edf84ce25ef67151c322bb0eb">&#9670;&#160;</a></span>LockGuard() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Lockable&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classtk_1_1_lock_guard.html">tk::LockGuard</a>&lt; Lockable &gt;::LockGuard </td>
          <td>(</td>
          <td class="paramtype">Lockable &amp;</td>          <td class="paramname"><span class="paramname"><em>m</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>ロック対象を受け取り、即座に <a class="el" href="namespacetk.html#a6540aa25eb8562f6d6c8b37977d6cfe8" title="ハードウェアスピンロックと全割り込み禁止によるクリティカルセクションに入ります">lock()</a> します </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">m</td><td>ロック対象のミューテックス参照 </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a52eeb50abee00bd0ed16cfa6618ce40f" name="a52eeb50abee00bd0ed16cfa6618ce40f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52eeb50abee00bd0ed16cfa6618ce40f">&#9670;&#160;</a></span>~LockGuard()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Lockable&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classtk_1_1_lock_guard.html">tk::LockGuard</a>&lt; Lockable &gt;::~<a class="el" href="#a3a922c7edf84ce25ef67151c322bb0eb">LockGuard</a> </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>スコープ終了時に自動的に <a class="el" href="namespacetk.html#a752b12f6862815c94a52347af52578b7" title="tk::lock() で入ったクリティカルセクションを抜けます">unlock()</a> します </p>

</div>
</div>
<a id="af9bc86bc2036c4b8e54633ddee811604" name="af9bc86bc2036c4b8e54633ddee811604"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9bc86bc2036c4b8e54633ddee811604">&#9670;&#160;</a></span>LockGuard() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Lockable&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classtk_1_1_lock_guard.html">tk::LockGuard</a>&lt; Lockable &gt;::LockGuard </td>
          <td>(</td>
          <td class="paramtype">const LockGuard&lt; Lockable &gt; &amp;</td>          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel delete">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a3f121f8aa1307f0f6e6e608cf138340c" name="a3f121f8aa1307f0f6e6e608cf138340c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f121f8aa1307f0f6e6e608cf138340c">&#9670;&#160;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Lockable&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#a3a922c7edf84ce25ef67151c322bb0eb">LockGuard</a> &amp; <a class="el" href="classtk_1_1_lock_guard.html">tk::LockGuard</a>&lt; Lockable &gt;::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="#a3a922c7edf84ce25ef67151c322bb0eb">LockGuard</a>&lt; Lockable &gt; &amp;</td>          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel delete">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/yoneda/Documents/Pico_Projects/tinykernel/tinykernel/include/tinykernel/<a class="el" href="sync_8hpp_source.html">sync.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a href="namespacetk.html">tk</a></li><li class="navelem"><a href="classtk_1_1_lock_guard.html">LockGuard</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.18.0 </li>
  </ul>
</div>
</body>
</html>