classtk_1_1_preempt_guard.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="ja">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.18.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>tinykernel: tk::PreemptGuard クラス</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="codefolding.js"></script>
  11. <script type="text/javascript" src="clipboard.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="navtreedata.js"></script>
  14. <script type="text/javascript" src="navtree.js"></script>
  15. <script type="text/javascript" src="cookie.js"></script>
  16. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  17. <script type="text/javascript" src="search/searchdata.js"></script>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20. </head>
  21. <body>
  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23. <div id="titlearea">
  24. <table cellspacing="0" cellpadding="0">
  25. <tbody>
  26. <tr id="projectrow">
  27. <td id="projectalign">
  28. <div id="projectname">tinykernel
  29. </div>
  30. </td>
  31. </tr>
  32. </tbody>
  33. </table>
  34. </div>
  35. <!-- end header part -->
  36. <!-- 構築: Doxygen 1.18.0 -->
  37. <script type="text/javascript">
  38. let searchBox = new SearchBox("searchBox", "search/",'.html');
  39. </script>
  40. <script type="text/javascript">
  41. document.addEventListener('DOMContentLoaded', codefold.init);
  42. </script>
  43. <script type="application/json" id="doxygen-config">
  44. {
  45. "relPath": "",
  46. "generateTreeView": true,
  47. "searchEngine": true,
  48. "serverBasedSearch": false,
  49. "disableIndex": false,
  50. "dynamicMenus": true,
  51. "fullSidebar": false
  52. }
  53. </script>
  54. <script type="text/javascript" src="menudata.js"></script>
  55. <script type="text/javascript" src="menu.js"></script>
  56. <div id="main-nav-mobile">
  57. <div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
  58. <label class="main-menu-btn" for="main-menu-state">
  59. <span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
  60. <span id="searchBoxPos1"></span>
  61. </div>
  62. </div><!-- main-nav-mobile -->
  63. <div id="main-nav">
  64. <ul class="sm sm-dox" id="main-menu">
  65. <li id="searchBoxPos2">
  66. <div id="MSearchBox" class="MSearchBoxInactive">
  67. <span class="left">
  68. <span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
  69. <input type="text" id="MSearchField" value="" placeholder="検索" accesskey="S"/>
  70. </span><span class="right">
  71. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
  72. </span>
  73. </div>
  74. </li>
  75. </ul>
  76. </div><!-- main-nav -->
  77. </div><!-- top -->
  78. <div id="side-nav" class="ui-resizable side-nav-resizable">
  79. <div id="nav-tree">
  80. <div id="nav-tree-contents">
  81. <div id="nav-sync" class="sync"></div>
  82. </div>
  83. </div>
  84. <div id="splitbar" class="ui-resizable-handle">
  85. </div>
  86. </div>
  87. <script type="text/javascript">
  88. document.addEventListener('DOMContentLoaded',() => { initNavTree('classtk_1_1_preempt_guard.html','','classtk_1_1_preempt_guard-members'); });
  89. </script>
  90. <div id="container">
  91. <div id="doc-content">
  92. <!-- window showing the filter options -->
  93. <div id="MSearchSelectWindow">
  94. </div>
  95. <!-- iframe showing the search results (closed by default) -->
  96. <div id="MSearchResultsWindow">
  97. <div id="MSearchResults">
  98. <div class="SRPage">
  99. <div id="SRIndex">
  100. <div id="SRResults"></div>
  101. <div class="SRStatus" id="Loading">読み取り中…</div>
  102. <div class="SRStatus" id="Searching">検索中…</div>
  103. <div class="SRStatus" id="NoMatches">一致する文字列を見つけられません</div>
  104. </div>
  105. </div>
  106. </div>
  107. </div>
  108. <div class="header">
  109. <div class="headertitle"><div class="title">tk::PreemptGuard クラス</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p>プリエンプション禁止をスコープ単位で安全に管理する RAII クラス
  113. <a href="#details">[詳解]</a></p>
  114. <p><code>#include &lt;<a class="el" href="kernel_8hpp_source.html">kernel.hpp</a>&gt;</code></p>
  115. <table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  117. 公開メンバ関数</h2></td></tr>
  118. <tr class="memitem:a39e396ce51420c942e7d6549ec63f88e" id="r_a39e396ce51420c942e7d6549ec63f88e"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a39e396ce51420c942e7d6549ec63f88e">PreemptGuard</a> ()</td></tr>
  119. <tr class="memitem:a329ea4d806861d9455168aeb01f41f86" id="r_a329ea4d806861d9455168aeb01f41f86"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a329ea4d806861d9455168aeb01f41f86">~PreemptGuard</a> ()</td></tr>
  120. <tr class="memitem:a360ac2b073064abc0f21db3127e7f389" id="r_a360ac2b073064abc0f21db3127e7f389"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a360ac2b073064abc0f21db3127e7f389">PreemptGuard</a> (const PreemptGuard &amp;)=delete</td></tr>
  121. <tr class="memitem:ad651c301bd81f95866e1cd380c2a2417" id="r_ad651c301bd81f95866e1cd380c2a2417"><td class="memItemLeft"><a class="el" href="#a39e396ce51420c942e7d6549ec63f88e">PreemptGuard</a> &amp;&#160;</td><td class="memItemRight"><a class="el" href="#ad651c301bd81f95866e1cd380c2a2417">operator=</a> (const <a class="el" href="#a39e396ce51420c942e7d6549ec63f88e">PreemptGuard</a> &amp;)=delete</td></tr>
  122. </table>
  123. <a name="details" id="details"></a><h2 id="header-details" class="groupheader">詳解</h2>
  124. <div class="textblock"><p>プリエンプション禁止をスコープ単位で安全に管理する RAII クラス </p>
  125. <p>生成時に自動で <span class="tt"><a class="el" href="namespacetk.html#a3254a7e2a9f5ed3abe44e8cf62a8dcfe" title="自コアのタスクスイッチ (プリエンプション) を一時的に禁止します">tk::preempt_disable()</a></span> を呼び、スコープを抜けた際に自動で <span class="tt"><a class="el" href="namespacetk.html#a70e6ee5f456e67a24ce13ff0fd04e4d9" title="自コアのタスクスイッチ (プリエンプション) を再開します">tk::preempt_enable()</a></span> を呼びます。</p>
  126. <div class="fragment"><div class="line">{</div>
  127. <div class="line"> <a class="code hl_class" href="classtk_1_1_preempt_guard.html">tk::PreemptGuard</a> guard;</div>
  128. <div class="line"> <span class="comment">// この区間はタスクスイッチが発生しない (I2C/SPI通信などに最適)</span></div>
  129. <div class="line"> i2c_write_blocking(...);</div>
  130. <div class="line">} <span class="comment">// 自動でタスクスイッチが再開</span></div>
  131. <div class="ttc" id="aclasstk_1_1_preempt_guard_html"><div class="ttname"><a href="classtk_1_1_preempt_guard.html">tk::PreemptGuard</a></div><div class="ttdoc">プリエンプション禁止をスコープ単位で安全に管理する RAII クラス</div><div class="ttdef"><b>定義</b> kernel.hpp:156</div></div>
  132. </div><!-- fragment --> </div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">構築子と解体子</h2>
  133. <a id="a39e396ce51420c942e7d6549ec63f88e" name="a39e396ce51420c942e7d6549ec63f88e"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#a39e396ce51420c942e7d6549ec63f88e">&#9670;&#160;</a></span>PreemptGuard() <span class="overload">[1/2]</span></h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="mlabels">
  138. <tr>
  139. <td class="mlabels-left">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">tk::PreemptGuard::PreemptGuard </td>
  143. <td>(</td>
  144. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </td>
  149. <td class="mlabels-right">
  150. <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
  151. </tr>
  152. </table>
  153. </div><div class="memdoc">
  154. </div>
  155. </div>
  156. <a id="a329ea4d806861d9455168aeb01f41f86" name="a329ea4d806861d9455168aeb01f41f86"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#a329ea4d806861d9455168aeb01f41f86">&#9670;&#160;</a></span>~PreemptGuard()</h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="mlabels">
  161. <tr>
  162. <td class="mlabels-left">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">tk::PreemptGuard::~PreemptGuard </td>
  166. <td>(</td>
  167. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. </div>
  178. </div>
  179. <a id="a360ac2b073064abc0f21db3127e7f389" name="a360ac2b073064abc0f21db3127e7f389"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#a360ac2b073064abc0f21db3127e7f389">&#9670;&#160;</a></span>PreemptGuard() <span class="overload">[2/2]</span></h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="mlabels">
  184. <tr>
  185. <td class="mlabels-left">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">tk::PreemptGuard::PreemptGuard </td>
  189. <td>(</td>
  190. <td class="paramtype">const PreemptGuard &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  191. <td></td>
  192. </tr>
  193. </table>
  194. </td>
  195. <td class="mlabels-right">
  196. <span class="mlabels"><span class="mlabel delete">delete</span></span> </td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. </div>
  201. </div>
  202. <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">関数詳解</h2>
  203. <a id="ad651c301bd81f95866e1cd380c2a2417" name="ad651c301bd81f95866e1cd380c2a2417"></a>
  204. <h2 class="memtitle"><span class="permalink"><a href="#ad651c301bd81f95866e1cd380c2a2417">&#9670;&#160;</a></span>operator=()</h2>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="mlabels">
  208. <tr>
  209. <td class="mlabels-left">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname"><a class="el" href="#a39e396ce51420c942e7d6549ec63f88e">PreemptGuard</a> &amp; tk::PreemptGuard::operator= </td>
  213. <td>(</td>
  214. <td class="paramtype">const <a class="el" href="#a39e396ce51420c942e7d6549ec63f88e">PreemptGuard</a> &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  215. <td></td>
  216. </tr>
  217. </table>
  218. </td>
  219. <td class="mlabels-right">
  220. <span class="mlabels"><span class="mlabel delete">delete</span></span> </td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. </div>
  225. </div>
  226. <hr/>このクラス詳解は次のファイルから抽出されました:<ul>
  227. <li>C:/Users/yoneda/Documents/Pico_Projects/tinykernel/tinykernel/include/tinykernel/<a class="el" href="kernel_8hpp_source.html">kernel.hpp</a></li>
  228. </ul>
  229. </div><!-- contents -->
  230. </div><!-- doc-content -->
  231. <div id="page-nav" class="page-nav-panel">
  232. <div id="page-nav-resize-handle"></div>
  233. <div id="page-nav-tree">
  234. <div id="page-nav-contents">
  235. </div><!-- page-nav-contents -->
  236. </div><!-- page-nav-tree -->
  237. </div><!-- page-nav -->
  238. </div><!-- container -->
  239. <!-- start footer part -->
  240. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  241. <ul>
  242. <li class="navelem"><a href="namespacetk.html">tk</a></li><li class="navelem"><a href="classtk_1_1_preempt_guard.html">PreemptGuard</a></li>
  243. <li class="footer">構築: <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>
  244. </ul>
  245. </div>
  246. </body>
  247. </html>