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

<p>計数セマフォ (Counting <a class="el" href="classtk_1_1_semaphore.html" title="計数セマフォ (Counting Semaphore) / バイナリセマフォ">Semaphore</a>) / バイナリセマフォ  
 <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:a66c5ac90338a6fcc6a9c2f22f1586de8" id="r_a66c5ac90338a6fcc6a9c2f22f1586de8"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a66c5ac90338a6fcc6a9c2f22f1586de8">Semaphore</a> (int32_t initial_count=1, int32_t max_count=1)</td></tr>
<tr class="memdesc:a66c5ac90338a6fcc6a9c2f22f1586de8"><td class="mdescLeft">&#160;</td><td class="mdescRight">セマフォを初期化します  <br /></td></tr>
<tr class="memitem:a863ccee07bc701a78342c14503955d73" id="r_a863ccee07bc701a78342c14503955d73"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a863ccee07bc701a78342c14503955d73">acquire</a> ()</td></tr>
<tr class="memdesc:a863ccee07bc701a78342c14503955d73"><td class="mdescLeft">&#160;</td><td class="mdescRight">資源を獲得するまで現在のタスクをブロックします  <br /></td></tr>
<tr class="memitem:a3a246c8afc866dc438186d0a53cad5c2" id="r_a3a246c8afc866dc438186d0a53cad5c2"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#a3a246c8afc866dc438186d0a53cad5c2">try_acquire</a> ()</td></tr>
<tr class="memdesc:a3a246c8afc866dc438186d0a53cad5c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">資源の獲得を試みます (ノンブロッキング)  <br /></td></tr>
<tr class="memitem:a7bb8eb8b0bd69b2f6b0a4d89d0f5b07b" id="r_a7bb8eb8b0bd69b2f6b0a4d89d0f5b07b"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a7bb8eb8b0bd69b2f6b0a4d89d0f5b07b">release</a> ()</td></tr>
<tr class="memdesc:a7bb8eb8b0bd69b2f6b0a4d89d0f5b07b"><td class="mdescLeft">&#160;</td><td class="mdescRight">資源を返却し、待機中タスクがあれば最優先度のタスクを 1 つ起床させます  <br /></td></tr>
<tr class="memitem:ae53b9c57cc25fafb242a21776f112701" id="r_ae53b9c57cc25fafb242a21776f112701"><td class="memItemLeft">int32_t&#160;</td><td class="memItemRight"><a class="el" href="#ae53b9c57cc25fafb242a21776f112701">count</a> () const</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>計数セマフォ (Counting <a class="el" href="classtk_1_1_semaphore.html" title="計数セマフォ (Counting Semaphore) / バイナリセマフォ">Semaphore</a>) / バイナリセマフォ </p>
<p>資源の獲得・返却によるタスク間同期を行います。資源がない場合はタスクが <span class="tt">State::Blocked</span> に遷移して休止し、返却時に優先度の高いタスクから順に起床します。</p>
<div class="fragment"><div class="line"><a class="code hl_class" href="classtk_1_1_semaphore.html">tk::Semaphore</a> sem(0, 5); <span class="comment">// 初期値0、最大5</span></div>
<div class="line"> </div>
<div class="line"><span class="comment">// タスク側 (資源が空くまでブロック待機)</span></div>
<div class="line">sem.acquire();</div>
<div class="line"> </div>
<div class="line"><span class="comment">// シグナル送信側 (割り込みや他タスクから返却・通知)</span></div>
<div class="line">sem.release();</div>
<div class="ttc" id="aclasstk_1_1_semaphore_html"><div class="ttname"><a href="classtk_1_1_semaphore.html">tk::Semaphore</a></div><div class="ttdoc">計数セマフォ (Counting Semaphore) / バイナリセマフォ</div><div class="ttdef"><b>Definition</b> sync.hpp:24</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="a66c5ac90338a6fcc6a9c2f22f1586de8" name="a66c5ac90338a6fcc6a9c2f22f1586de8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66c5ac90338a6fcc6a9c2f22f1586de8">&#9670;&#160;</a></span>Semaphore()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">tk::Semaphore::Semaphore </td>
          <td>(</td>
          <td class="paramtype">int32_t</td>          <td class="paramname"><span class="paramname"><em>initial_count</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t</td>          <td class="paramname"><span class="paramname"><em>max_count</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</span>&#160;)</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>セマフォを初期化します </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">initial_count</td><td>初期資源カウント (省略時: 1) </td></tr>
    <tr><td class="paramname">max_count</td><td>最大資源カウント (省略時: 1) </td></tr>
  </table>
  </dd>
</dl>

</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="a863ccee07bc701a78342c14503955d73" name="a863ccee07bc701a78342c14503955d73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a863ccee07bc701a78342c14503955d73">&#9670;&#160;</a></span>acquire()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void tk::Semaphore::acquire </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>資源カウントが 0 以下の場合はタスクが休止状態になり、CPU は他タスクへ譲渡されます (CPU消費ゼロ)。 </p>

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

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void tk::Semaphore::release </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>資源を返却し、待機中タスクがあれば最優先度のタスクを 1 つ起床させます </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool tk::Semaphore::try_acquire </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 獲得成功 (カウントが 1 減算された) </dd>
<dd>
false 資源がないため獲得失敗 (ブロックせず即座に復帰) </dd></dl>

</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_semaphore.html">Semaphore</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>