tinykernel/docs/html/classtk_1_1_mutex.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::Mutex Class 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_mutex.html','','classtk_1_1_mutex-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::Mutex Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>所有権・優先度順ウェイクアップ・RAII 対応のミューテックス (排他ロック)  
 <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:a8b17431db60f4ab48a3859b2ca722eb1" id="r_a8b17431db60f4ab48a3859b2ca722eb1"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a8b17431db60f4ab48a3859b2ca722eb1">Mutex</a> ()=default</td></tr>
<tr class="memitem:a7f5645bba55df2db263f92a954802c27" id="r_a7f5645bba55df2db263f92a954802c27"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a7f5645bba55df2db263f92a954802c27">lock</a> ()</td></tr>
<tr class="memdesc:a7f5645bba55df2db263f92a954802c27"><td class="mdescLeft">&#160;</td><td class="mdescRight">ミューテックスをロックします (空くまでブロック待機)  <br /></td></tr>
<tr class="memitem:a666dd03fb22c5cb855e3145f76a58b9c" id="r_a666dd03fb22c5cb855e3145f76a58b9c"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#a666dd03fb22c5cb855e3145f76a58b9c">try_lock</a> ()</td></tr>
<tr class="memdesc:a666dd03fb22c5cb855e3145f76a58b9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">ミューテックスのロックを試みます (ノンブロッキング)  <br /></td></tr>
<tr class="memitem:ae8d5dfd5655b5aa54d63db6e0cf2f707" id="r_ae8d5dfd5655b5aa54d63db6e0cf2f707"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#ae8d5dfd5655b5aa54d63db6e0cf2f707">unlock</a> ()</td></tr>
<tr class="memdesc:ae8d5dfd5655b5aa54d63db6e0cf2f707"><td class="mdescLeft">&#160;</td><td class="mdescRight">ミューテックスのロックを解除します  <br /></td></tr>
<tr class="memitem:acf574e35540879481f1f6e5452a504ab" id="r_acf574e35540879481f1f6e5452a504ab"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#acf574e35540879481f1f6e5452a504ab">is_locked</a> () const</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>所有権・優先度順ウェイクアップ・RAII 対応のミューテックス (排他ロック) </p>
<p>共有リソースやペリフェラルへの同時アクセスを防止します。 ロックしたタスク本人以外の誤った <span class="tt"><a class="el" href="#ae8d5dfd5655b5aa54d63db6e0cf2f707" title="ミューテックスのロックを解除します">unlock()</a></span> は安全に無視されます。 C++ の <span class="tt">BasicLockable</span> を満たしており、<span class="tt">std::lock_guard</span> や <span class="tt"><a class="el" href="classtk_1_1_lock_guard.html" title="ミューテックスのロックをスコープ単位で安全に管理する RAII クラス (std::lock_guard 相当)">tk::LockGuard</a></span> が利用可能です。</p>
<div class="fragment"><div class="line"><a class="code hl_class" href="classtk_1_1_mutex.html">tk::Mutex</a> mtx;</div>
<div class="line"> </div>
<div class="line">{</div>
<div class="line">    <a class="code hl_class" href="classtk_1_1_lock_guard.html">tk::LockGuard&lt;tk::Mutex&gt;</a> <a class="code hl_function" href="#a7f5645bba55df2db263f92a954802c27">lock</a>(mtx);</div>
<div class="line">    <span class="comment">// クリティカルセクション...</span></div>
<div class="line">} <span class="comment">// 自動でアンロック</span></div>
<div class="ttc" id="aclasstk_1_1_lock_guard_html"><div class="ttname"><a href="classtk_1_1_lock_guard.html">tk::LockGuard</a></div><div class="ttdoc">ミューテックスのロックをスコープ単位で安全に管理する RAII クラス (std::lock_guard 相当)</div><div class="ttdef"><b>Definition</b> sync.hpp:211</div></div>
<div class="ttc" id="aclasstk_1_1_mutex_html"><div class="ttname"><a href="classtk_1_1_mutex.html">tk::Mutex</a></div><div class="ttdoc">所有権・優先度順ウェイクアップ・RAII 対応のミューテックス (排他ロック)</div><div class="ttdef"><b>Definition</b> sync.hpp:123</div></div>
<div class="ttc" id="aclasstk_1_1_mutex_html_a7f5645bba55df2db263f92a954802c27"><div class="ttname"><a href="#a7f5645bba55df2db263f92a954802c27">tk::Mutex::lock</a></div><div class="ttdeci">void lock()</div><div class="ttdoc">ミューテックスをロックします (空くまでブロック待機)</div><div class="ttdef"><b>Definition</b> sync.hpp:132</div></div>
</div><!-- fragment --> </div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8b17431db60f4ab48a3859b2ca722eb1" name="a8b17431db60f4ab48a3859b2ca722eb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b17431db60f4ab48a3859b2ca722eb1">&#9670;&#160;</a></span>Mutex()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">tk::Mutex::Mutex </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 default">default</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="acf574e35540879481f1f6e5452a504ab" name="acf574e35540879481f1f6e5452a504ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf574e35540879481f1f6e5452a504ab">&#9670;&#160;</a></span>is_locked()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool tk::Mutex::is_locked </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</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>現在ロックされているかどうかを判定 </p>

</div>
</div>
<a id="a7f5645bba55df2db263f92a954802c27" name="a7f5645bba55df2db263f92a954802c27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f5645bba55df2db263f92a954802c27">&#9670;&#160;</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 tk::Mutex::lock </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>ミューテックスをロックします (空くまでブロック待機) </p>
<p>他のタスクが保持している場合は、解放されるまで自タスクを <span class="tt">State::Blocked</span> にして休止します。 </p>

</div>
</div>
<a id="a666dd03fb22c5cb855e3145f76a58b9c" name="a666dd03fb22c5cb855e3145f76a58b9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a666dd03fb22c5cb855e3145f76a58b9c">&#9670;&#160;</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 tk::Mutex::try_lock </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>ミューテックスのロックを試みます (ノンブロッキング) </p>
<dl class="section return"><dt>Returns</dt><dd>true ロック獲得成功 </dd>
<dd>
false 他のタスクが保持しているため獲得失敗 (ブロックせず即座に復帰) </dd></dl>

</div>
</div>
<a id="ae8d5dfd5655b5aa54d63db6e0cf2f707" name="ae8d5dfd5655b5aa54d63db6e0cf2f707"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8d5dfd5655b5aa54d63db6e0cf2f707">&#9670;&#160;</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 tk::Mutex::unlock </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>ミューテックスのロックを解除します </p>
<p>ロックを保持しているタスク本人だけが解除できます。 待機中のタスクが存在する場合、最も優先度が高いタスクを 1 つ起床させます。 </p>

</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_mutex.html">Mutex</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>