namespacetk.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601
  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="en-US">
  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 Namespace Reference</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. <!-- Generated by 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="Search" 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('namespacetk.html','',''); });
  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">Loading...</div>
  102. <div class="SRStatus" id="Searching">Searching...</div>
  103. <div class="SRStatus" id="NoMatches">No Matches</div>
  104. </div>
  105. </div>
  106. </div>
  107. </div>
  108. <div class="header">
  109. <div class="headertitle"><div class="title">tk Namespace Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 id="header-namespaces" class="groupheader"><a id="namespaces" name="namespaces"></a>
  114. Namespaces</h2></td></tr>
  115. <tr class="memitem:detail" id="r_detail"><td class="memItemLeft">namespace &#160;</td><td class="memItemRight"><a class="el" href="namespacetk_1_1detail.html">detail</a></td></tr>
  116. </table><table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  118. Classes</h2></td></tr>
  119. <tr class="memitem:Actor" id="r_Actor"><td class="memItemLeft">class &#160;</td><td class="memItemRight"><a class="el" href="classtk_1_1_actor.html">Actor</a></td></tr>
  120. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">メッセージ駆動型タスク (アクター) の基底クラス <a href="classtk_1_1_actor.html#details">More...</a><br /></td></tr>
  121. <tr class="memitem:EventHub" id="r_EventHub"><td class="memItemLeft">class &#160;</td><td class="memItemRight"><a class="el" href="classtk_1_1_event_hub.html">EventHub</a></td></tr>
  122. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">メッセージ型ごとの超軽量 Pub/Sub ディスパッチャ <a href="classtk_1_1_event_hub.html#details">More...</a><br /></td></tr>
  123. <tr class="memitem:LockGuard" id="r_LockGuard"><td class="memItemLeft">class &#160;</td><td class="memItemRight"><a class="el" href="classtk_1_1_lock_guard.html">LockGuard</a></td></tr>
  124. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">ミューテックスのロックをスコープ単位で安全に管理する RAII クラス (std::lock_guard 相当) <a href="classtk_1_1_lock_guard.html#details">More...</a><br /></td></tr>
  125. <tr class="memitem:Message" id="r_Message"><td class="memItemLeft">struct &#160;</td><td class="memItemRight"><a class="el" href="structtk_1_1_message.html">Message</a></td></tr>
  126. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">デフォルトの軽量メッセージ構造体 <a href="structtk_1_1_message.html#details">More...</a><br /></td></tr>
  127. <tr class="memitem:Mutex" id="r_Mutex"><td class="memItemLeft">class &#160;</td><td class="memItemRight"><a class="el" href="classtk_1_1_mutex.html">Mutex</a></td></tr>
  128. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">所有権・優先度順ウェイクアップ・RAII 対応のミューテックス (排他ロック) <a href="classtk_1_1_mutex.html#details">More...</a><br /></td></tr>
  129. <tr class="memitem:PreemptGuard" id="r_PreemptGuard"><td class="memItemLeft">class &#160;</td><td class="memItemRight"><a class="el" href="classtk_1_1_preempt_guard.html">PreemptGuard</a></td></tr>
  130. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">プリエンプション禁止をスコープ単位で安全に管理する RAII クラス <a href="classtk_1_1_preempt_guard.html#details">More...</a><br /></td></tr>
  131. <tr class="memitem:Semaphore" id="r_Semaphore"><td class="memItemLeft">class &#160;</td><td class="memItemRight"><a class="el" href="classtk_1_1_semaphore.html">Semaphore</a></td></tr>
  132. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">計数セマフォ (Counting <a class="el" href="classtk_1_1_semaphore.html" title="計数セマフォ (Counting Semaphore) / バイナリセマフォ">Semaphore</a>) / バイナリセマフォ <a href="classtk_1_1_semaphore.html#details">More...</a><br /></td></tr>
  133. <tr class="memitem:TaskHandle" id="r_TaskHandle"><td class="memItemLeft">struct &#160;</td><td class="memItemRight"><a class="el" href="structtk_1_1_task_handle.html">TaskHandle</a></td></tr>
  134. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">タスクの識別ハンドル <a href="structtk_1_1_task_handle.html#details">More...</a><br /></td></tr>
  135. </table><table class="memberdecls">
  136. <tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
  137. Typedefs</h2></td></tr>
  138. <tr class="memitem:a8908cf1e54cdc4e14ac3003126722cfc" id="r_a8908cf1e54cdc4e14ac3003126722cfc"><td class="memItemLeft">using&#160;</td><td class="memItemRight"><a class="el" href="#a8908cf1e54cdc4e14ac3003126722cfc">TaskFn</a> = void (*)(void* arg)</td></tr>
  139. <tr class="memitem:add371a241ec6c1695ef4e67935317edd" id="r_add371a241ec6c1695ef4e67935317edd"><td class="memItemLeft">using&#160;</td><td class="memItemRight"><a class="el" href="#add371a241ec6c1695ef4e67935317edd">task_mask_t</a> = uint32_t</td></tr>
  140. <tr class="memitem:ab1f2fa3d79e99f13610bd330a0df928b" id="r_ab1f2fa3d79e99f13610bd330a0df928b"><td class="memItemLeft">using&#160;</td><td class="memItemRight"><a class="el" href="#ab1f2fa3d79e99f13610bd330a0df928b">BinarySemaphore</a> = <a class="el" href="classtk_1_1_semaphore.html">Semaphore</a></td></tr>
  141. <tr class="memdesc:ab1f2fa3d79e99f13610bd330a0df928b"><td class="mdescLeft">&#160;</td><td class="mdescRight">バイナリセマフォ (初期値1, 最大1) の型エイリアス <br /></td></tr>
  142. </table><table class="memberdecls">
  143. <tr class="heading"><td colspan="2"><h2 id="header-enum-members" class="groupheader"><a id="enum-members" name="enum-members"></a>
  144. Enumerations</h2></td></tr>
  145. <tr class="memitem:a3d47fbd63b95ed3b46bed70c2fa1e50e" id="r_a3d47fbd63b95ed3b46bed70c2fa1e50e"><td class="memItemLeft">enum &#160;</td><td class="memItemRight"><a class="el" href="#a3d47fbd63b95ed3b46bed70c2fa1e50e">Prio</a> : uint32_t { <a class="el" href="#a3d47fbd63b95ed3b46bed70c2fa1e50eabbefd771d1fb2ac0708c1bd5371e5a75">PRIO_REALTIME</a> = 1
  146. , <a class="el" href="#a3d47fbd63b95ed3b46bed70c2fa1e50ea614240a3a3fc1094c6daa0fdca92ba37">PRIO_HIGH</a> = 5
  147. , <a class="el" href="#a3d47fbd63b95ed3b46bed70c2fa1e50ea0e6779023b97999c2cef66ba1d4d1fca">PRIO_NORMAL</a> = 9
  148. , <a class="el" href="#a3d47fbd63b95ed3b46bed70c2fa1e50eacf084edcfe985b77c205a37c3bd60519">PRIO_LOW</a> = 13
  149. }</td></tr>
  150. <tr class="memdesc:a3d47fbd63b95ed3b46bed70c2fa1e50e"><td class="mdescLeft">&#160;</td><td class="mdescRight">タスクの優先度レベル <a href="#a3d47fbd63b95ed3b46bed70c2fa1e50e">More...</a><br /></td></tr>
  151. </table><table class="memberdecls">
  152. <tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
  153. Functions</h2></td></tr>
  154. <tr class="memitem:a083495c9bf857a63f6c20a20aac0ca52" id="r_a083495c9bf857a63f6c20a20aac0ca52"><td class="memTemplParams" colspan="2">template&lt;typename MsgType&gt; </td></tr>
  155. <tr class="memitem:a083495c9bf857a63f6c20a20aac0ca52 template"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a083495c9bf857a63f6c20a20aac0ca52">publish</a> (const MsgType &amp;msg)</td></tr>
  156. <tr class="memdesc:a083495c9bf857a63f6c20a20aac0ca52"><td class="mdescLeft">&#160;</td><td class="mdescRight">メッセージの型を指定して、購読しているすべての <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> へ同報配信します <br /></td></tr>
  157. <tr class="memitem:a5549bec310750722a1964de1145b9fed" id="r_a5549bec310750722a1964de1145b9fed"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a5549bec310750722a1964de1145b9fed">publish</a> (uint32_t id, uintptr_t arg=0)</td></tr>
  158. <tr class="memdesc:a5549bec310750722a1964de1145b9fed"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structtk_1_1_message.html" title="デフォルトの軽量メッセージ構造体">tk::Message</a> 型の同報配信ショートカット <br /></td></tr>
  159. <tr class="memitem:a6e721332f5a7d85998345ed218de7394" id="r_a6e721332f5a7d85998345ed218de7394"><td class="memItemLeft"><a class="el" href="structtk_1_1_task_handle.html">TaskHandle</a>&#160;</td><td class="memItemRight"><a class="el" href="#a6e721332f5a7d85998345ed218de7394">create</a> (<a class="el" href="#a8908cf1e54cdc4e14ac3003126722cfc">TaskFn</a> fn, void *arg=nullptr, uint32_t prio=<a class="el" href="#a3d47fbd63b95ed3b46bed70c2fa1e50ea0e6779023b97999c2cef66ba1d4d1fca">PRIO_NORMAL</a>)</td></tr>
  160. <tr class="memdesc:a6e721332f5a7d85998345ed218de7394"><td class="mdescLeft">&#160;</td><td class="mdescRight">タスクを生成・登録します <br /></td></tr>
  161. <tr class="memitem:a675f1829b87e2a43239b6f80a526d0ed" id="r_a675f1829b87e2a43239b6f80a526d0ed"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a675f1829b87e2a43239b6f80a526d0ed">start</a> ()</td></tr>
  162. <tr class="memdesc:a675f1829b87e2a43239b6f80a526d0ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">tinykernel スケジューラを起動します <br /></td></tr>
  163. <tr class="memitem:a8081956b0a19b87d5b7c81b772373397" id="r_a8081956b0a19b87d5b7c81b772373397"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a8081956b0a19b87d5b7c81b772373397">yield</a> ()</td></tr>
  164. <tr class="memdesc:a8081956b0a19b87d5b7c81b772373397"><td class="mdescLeft">&#160;</td><td class="mdescRight">現在実行中のタスクを一時中断し、同優先度の他のタスクへ CPU を譲渡します <br /></td></tr>
  165. <tr class="memitem:aae83f84121085578a7568437a8dc2447" id="r_aae83f84121085578a7568437a8dc2447"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#aae83f84121085578a7568437a8dc2447">sleep_ms</a> (uint32_t ms)</td></tr>
  166. <tr class="memdesc:aae83f84121085578a7568437a8dc2447"><td class="mdescLeft">&#160;</td><td class="mdescRight">現在のタスクを指定時間スリープさせます <br /></td></tr>
  167. <tr class="memitem:aba50cfc62cb8be71cf96df7f495a7a3d" id="r_aba50cfc62cb8be71cf96df7f495a7a3d"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#aba50cfc62cb8be71cf96df7f495a7a3d">exit</a> (int code=0)</td></tr>
  168. <tr class="memdesc:aba50cfc62cb8be71cf96df7f495a7a3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">現在のタスクを終了・破棄します <br /></td></tr>
  169. <tr class="memitem:a46e15375fba47cbd1a93278f17e77848" id="r_a46e15375fba47cbd1a93278f17e77848"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#a46e15375fba47cbd1a93278f17e77848">now_ms</a> ()</td></tr>
  170. <tr class="memdesc:a46e15375fba47cbd1a93278f17e77848"><td class="mdescLeft">&#160;</td><td class="mdescRight">システム起動時からの経過時間をミリ秒単位で取得します <br /></td></tr>
  171. <tr class="memitem:a6540aa25eb8562f6d6c8b37977d6cfe8" id="r_a6540aa25eb8562f6d6c8b37977d6cfe8"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#a6540aa25eb8562f6d6c8b37977d6cfe8">lock</a> ()</td></tr>
  172. <tr class="memdesc:a6540aa25eb8562f6d6c8b37977d6cfe8"><td class="mdescLeft">&#160;</td><td class="mdescRight">ハードウェアスピンロックと全割り込み禁止によるクリティカルセクションに入ります <br /></td></tr>
  173. <tr class="memitem:a752b12f6862815c94a52347af52578b7" id="r_a752b12f6862815c94a52347af52578b7"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a752b12f6862815c94a52347af52578b7">unlock</a> (bool was_enabled)</td></tr>
  174. <tr class="memdesc:a752b12f6862815c94a52347af52578b7"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="#a6540aa25eb8562f6d6c8b37977d6cfe8" title="ハードウェアスピンロックと全割り込み禁止によるクリティカルセクションに入ります">tk::lock()</a> で入ったクリティカルセクションを抜けます <br /></td></tr>
  175. <tr class="memitem:a3254a7e2a9f5ed3abe44e8cf62a8dcfe" id="r_a3254a7e2a9f5ed3abe44e8cf62a8dcfe"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a3254a7e2a9f5ed3abe44e8cf62a8dcfe">preempt_disable</a> ()</td></tr>
  176. <tr class="memdesc:a3254a7e2a9f5ed3abe44e8cf62a8dcfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">自コアのタスクスイッチ (プリエンプション) を一時的に禁止します <br /></td></tr>
  177. <tr class="memitem:a70e6ee5f456e67a24ce13ff0fd04e4d9" id="r_a70e6ee5f456e67a24ce13ff0fd04e4d9"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a70e6ee5f456e67a24ce13ff0fd04e4d9">preempt_enable</a> ()</td></tr>
  178. <tr class="memdesc:a70e6ee5f456e67a24ce13ff0fd04e4d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">自コアのタスクスイッチ (プリエンプション) を再開します <br /></td></tr>
  179. </table>
  180. <a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2>
  181. <a id="ab1f2fa3d79e99f13610bd330a0df928b" name="ab1f2fa3d79e99f13610bd330a0df928b"></a>
  182. <h2 class="memtitle"><span class="permalink"><a href="#ab1f2fa3d79e99f13610bd330a0df928b">&#9670;&#160;</a></span>BinarySemaphore</h2>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">using <a class="el" href="#ab1f2fa3d79e99f13610bd330a0df928b">tk::BinarySemaphore</a> = <a class="el" href="classtk_1_1_semaphore.html">Semaphore</a></td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>バイナリセマフォ (初期値1, 最大1) の型エイリアス </p>
  192. </div>
  193. </div>
  194. <a id="add371a241ec6c1695ef4e67935317edd" name="add371a241ec6c1695ef4e67935317edd"></a>
  195. <h2 class="memtitle"><span class="permalink"><a href="#add371a241ec6c1695ef4e67935317edd">&#9670;&#160;</a></span>task_mask_t</h2>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">using <a class="el" href="#add371a241ec6c1695ef4e67935317edd">tk::task_mask_t</a> = uint32_t</td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. </div>
  205. </div>
  206. <a id="a8908cf1e54cdc4e14ac3003126722cfc" name="a8908cf1e54cdc4e14ac3003126722cfc"></a>
  207. <h2 class="memtitle"><span class="permalink"><a href="#a8908cf1e54cdc4e14ac3003126722cfc">&#9670;&#160;</a></span>TaskFn</h2>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">using <a class="el" href="#a8908cf1e54cdc4e14ac3003126722cfc">tk::TaskFn</a> = void (*)(void* arg)</td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>タスク関数のシグネチャ (void func(void* arg)) </p>
  217. </div>
  218. </div>
  219. <a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Enumeration Type Documentation</h2>
  220. <a id="a3d47fbd63b95ed3b46bed70c2fa1e50e" name="a3d47fbd63b95ed3b46bed70c2fa1e50e"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#a3d47fbd63b95ed3b46bed70c2fa1e50e">&#9670;&#160;</a></span>Prio</h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">enum <a class="el" href="#a3d47fbd63b95ed3b46bed70c2fa1e50e">tk::Prio</a> : uint32_t</td>
  227. </tr>
  228. </table>
  229. </div><div class="memdoc">
  230. <p>タスクの優先度レベル </p>
  231. <p>数値が小さいほど高優先度です。0..15 の範囲で指定します (15 はアイドルタスク専用)。 </p>
  232. <table class="fieldtable">
  233. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3d47fbd63b95ed3b46bed70c2fa1e50eabbefd771d1fb2ac0708c1bd5371e5a75" name="a3d47fbd63b95ed3b46bed70c2fa1e50eabbefd771d1fb2ac0708c1bd5371e5a75"></a>PRIO_REALTIME&#160;</td><td class="fielddoc"><p>リアルタイム最優先 </p>
  234. </td></tr>
  235. <tr><td class="fieldname"><a id="a3d47fbd63b95ed3b46bed70c2fa1e50ea614240a3a3fc1094c6daa0fdca92ba37" name="a3d47fbd63b95ed3b46bed70c2fa1e50ea614240a3a3fc1094c6daa0fdca92ba37"></a>PRIO_HIGH&#160;</td><td class="fielddoc"><p>高優先度 </p>
  236. </td></tr>
  237. <tr><td class="fieldname"><a id="a3d47fbd63b95ed3b46bed70c2fa1e50ea0e6779023b97999c2cef66ba1d4d1fca" name="a3d47fbd63b95ed3b46bed70c2fa1e50ea0e6779023b97999c2cef66ba1d4d1fca"></a>PRIO_NORMAL&#160;</td><td class="fielddoc"><p>通常優先度 (デフォルト) </p>
  238. </td></tr>
  239. <tr><td class="fieldname"><a id="a3d47fbd63b95ed3b46bed70c2fa1e50eacf084edcfe985b77c205a37c3bd60519" name="a3d47fbd63b95ed3b46bed70c2fa1e50eacf084edcfe985b77c205a37c3bd60519"></a>PRIO_LOW&#160;</td><td class="fielddoc"><p>低優先度 </p>
  240. </td></tr>
  241. </table>
  242. </div>
  243. </div>
  244. <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
  245. <a id="a6e721332f5a7d85998345ed218de7394" name="a6e721332f5a7d85998345ed218de7394"></a>
  246. <h2 class="memtitle"><span class="permalink"><a href="#a6e721332f5a7d85998345ed218de7394">&#9670;&#160;</a></span>create()</h2>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname"><a class="el" href="structtk_1_1_task_handle.html">tk::TaskHandle</a> tk::create </td>
  252. <td>(</td>
  253. <td class="paramtype"><a class="el" href="#a8908cf1e54cdc4e14ac3003126722cfc">TaskFn</a></td> <td class="paramname"><span class="paramname"><em>fn</em></span>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>arg</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span>, </td>
  259. </tr>
  260. <tr>
  261. <td class="paramkey"></td>
  262. <td></td>
  263. <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>prio</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="#a3d47fbd63b95ed3b46bed70c2fa1e50ea0e6779023b97999c2cef66ba1d4d1fca">PRIO_NORMAL</a></span>&#160;)</td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>タスクを生成・登録します </p>
  268. <p><a class="el" href="#a675f1829b87e2a43239b6f80a526d0ed" title="tinykernel スケジューラを起動します">tk::start()</a> を呼び出す前に登録する必要があります。</p>
  269. <dl class="params"><dt>Parameters</dt><dd>
  270. <table class="params">
  271. <tr><td class="paramname">fn</td><td>タスク関数ポインタ (void (*)(void* arg)) </td></tr>
  272. <tr><td class="paramname">arg</td><td>タスク関数に渡すユーザー引数ポインタ (省略時: nullptr) </td></tr>
  273. <tr><td class="paramname">prio</td><td>タスクの優先度 (省略時: <a class="el" href="#a3d47fbd63b95ed3b46bed70c2fa1e50ea0e6779023b97999c2cef66ba1d4d1fca" title="通常優先度 (デフォルト)">tk::PRIO_NORMAL</a>) </td></tr>
  274. </table>
  275. </dd>
  276. </dl>
  277. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structtk_1_1_task_handle.html" title="タスクの識別ハンドル">TaskHandle</a> 生成されたタスクのハンドル。登録失敗時は is_valid() が false </dd></dl>
  278. </div>
  279. </div>
  280. <a id="aba50cfc62cb8be71cf96df7f495a7a3d" name="aba50cfc62cb8be71cf96df7f495a7a3d"></a>
  281. <h2 class="memtitle"><span class="permalink"><a href="#aba50cfc62cb8be71cf96df7f495a7a3d">&#9670;&#160;</a></span>exit()</h2>
  282. <div class="memitem">
  283. <div class="memproto">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">void tk::exit </td>
  287. <td>(</td>
  288. <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>code</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span></td><td>)</td>
  289. <td></td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <p>現在のタスクを終了・破棄します </p>
  294. <dl class="params"><dt>Parameters</dt><dd>
  295. <table class="params">
  296. <tr><td class="paramname">code</td><td>終了コード (予約用、省略時: 0) </td></tr>
  297. </table>
  298. </dd>
  299. </dl>
  300. <dl class="section note"><dt>Note</dt><dd>タスク関数の末尾に到達した場合は自動的に呼ばれます。 </dd></dl>
  301. </div>
  302. </div>
  303. <a id="a6540aa25eb8562f6d6c8b37977d6cfe8" name="a6540aa25eb8562f6d6c8b37977d6cfe8"></a>
  304. <h2 class="memtitle"><span class="permalink"><a href="#a6540aa25eb8562f6d6c8b37977d6cfe8">&#9670;&#160;</a></span>lock()</h2>
  305. <div class="memitem">
  306. <div class="memproto">
  307. <table class="memname">
  308. <tr>
  309. <td class="memname">bool tk::lock </td>
  310. <td>(</td>
  311. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  312. <td></td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <p>ハードウェアスピンロックと全割り込み禁止によるクリティカルセクションに入ります </p>
  317. <dl class="section return"><dt>Returns</dt><dd>true 呼び出し前の割り込みが有効だった場合 </dd>
  318. <dd>
  319. false 呼び出し前の割り込みが無効だった場合 </dd></dl>
  320. <dl class="section warning"><dt>Warning</dt><dd>長時間のロックは避けてください。数マイクロ秒以内のレジスタ操作等に使用します。 </dd></dl>
  321. </div>
  322. </div>
  323. <a id="a46e15375fba47cbd1a93278f17e77848" name="a46e15375fba47cbd1a93278f17e77848"></a>
  324. <h2 class="memtitle"><span class="permalink"><a href="#a46e15375fba47cbd1a93278f17e77848">&#9670;&#160;</a></span>now_ms()</h2>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname">uint64_t tk::now_ms </td>
  330. <td>(</td>
  331. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  332. <td></td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>システム起動時からの経過時間をミリ秒単位で取得します </p>
  337. <dl class="section return"><dt>Returns</dt><dd>uint64_t 経過ミリ秒数 (分解能: 1 / TK_TICKS_PER_SEC 秒) </dd></dl>
  338. </div>
  339. </div>
  340. <a id="a3254a7e2a9f5ed3abe44e8cf62a8dcfe" name="a3254a7e2a9f5ed3abe44e8cf62a8dcfe"></a>
  341. <h2 class="memtitle"><span class="permalink"><a href="#a3254a7e2a9f5ed3abe44e8cf62a8dcfe">&#9670;&#160;</a></span>preempt_disable()</h2>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">void tk::preempt_disable </td>
  347. <td>(</td>
  348. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  349. <td></td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>自コアのタスクスイッチ (プリエンプション) を一時的に禁止します </p>
  354. <p>割り込み (SysTick やタイマー、NVIC) は停止しないため、通信クロックや時刻更新を 阻害することなく、自タスクの処理をアトミックに実行できます。ネスト (入れ子) 呼び出しに対応しています。</p>
  355. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classtk_1_1_preempt_guard.html" title="プリエンプション禁止をスコープ単位で安全に管理する RAII クラス">tk::PreemptGuard</a>, <a class="el" href="#a70e6ee5f456e67a24ce13ff0fd04e4d9" title="自コアのタスクスイッチ (プリエンプション) を再開します">tk::preempt_enable()</a> </dd></dl>
  356. </div>
  357. </div>
  358. <a id="a70e6ee5f456e67a24ce13ff0fd04e4d9" name="a70e6ee5f456e67a24ce13ff0fd04e4d9"></a>
  359. <h2 class="memtitle"><span class="permalink"><a href="#a70e6ee5f456e67a24ce13ff0fd04e4d9">&#9670;&#160;</a></span>preempt_enable()</h2>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="memname">
  363. <tr>
  364. <td class="memname">void tk::preempt_enable </td>
  365. <td>(</td>
  366. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  367. <td></td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. <p>自コアのタスクスイッチ (プリエンプション) を再開します </p>
  372. <p>ネストカウンタが 0 に戻った時点で、保留されていたタスクスイッチが即座に実行されます。</p>
  373. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classtk_1_1_preempt_guard.html" title="プリエンプション禁止をスコープ単位で安全に管理する RAII クラス">tk::PreemptGuard</a>, <a class="el" href="#a3254a7e2a9f5ed3abe44e8cf62a8dcfe" title="自コアのタスクスイッチ (プリエンプション) を一時的に禁止します">tk::preempt_disable()</a> </dd></dl>
  374. </div>
  375. </div>
  376. <a id="a083495c9bf857a63f6c20a20aac0ca52" name="a083495c9bf857a63f6c20a20aac0ca52"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#a083495c9bf857a63f6c20a20aac0ca52">&#9670;&#160;</a></span>publish() <span class="overload">[1/2]</span></h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <div class="memtemplate">
  381. template&lt;typename MsgType&gt; </div>
  382. <table class="mlabels">
  383. <tr>
  384. <td class="mlabels-left">
  385. <table class="memname">
  386. <tr>
  387. <td class="memname">size_t tk::publish </td>
  388. <td>(</td>
  389. <td class="paramtype">const MsgType &amp;</td> <td class="paramname"><span class="paramname"><em>msg</em></span></td><td>)</td>
  390. <td></td>
  391. </tr>
  392. </table>
  393. </td>
  394. <td class="mlabels-right">
  395. <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>メッセージの型を指定して、購読しているすべての <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> へ同報配信します </p>
  400. <p>送信側は <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> のインスタンスや名前を知る必要がありません (完全疎結合)。 メッセージの実体は各 <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> のキューへ値コピーされるため、スタック上のローカル変数でも安全に渡せます。</p>
  401. <dl class="tparams"><dt>Template Parameters</dt><dd>
  402. <table class="tparams">
  403. <tr><td class="paramname">MsgType</td><td>配信するメッセージ型 </td></tr>
  404. </table>
  405. </dd>
  406. </dl>
  407. <dl class="params"><dt>Parameters</dt><dd>
  408. <table class="params">
  409. <tr><td class="paramname">msg</td><td>送信するメッセージ </td></tr>
  410. </table>
  411. </dd>
  412. </dl>
  413. <dl class="section return"><dt>Returns</dt><dd>size_t 配信に成功した <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> の数</dd></dl>
  414. <div class="fragment"><div class="line">MyEvent ev{1, <span class="stringliteral">&quot;Button Pressed&quot;</span>};</div>
  415. <div class="line"><a class="code hl_function" href="#a083495c9bf857a63f6c20a20aac0ca52">tk::publish</a>(ev); <span class="comment">// MyEvent を受け付けるすべての Actor に届く</span></div>
  416. <div class="ttc" id="anamespacetk_html_a083495c9bf857a63f6c20a20aac0ca52"><div class="ttname"><a href="#a083495c9bf857a63f6c20a20aac0ca52">tk::publish</a></div><div class="ttdeci">size_t publish(const MsgType &amp;msg)</div><div class="ttdoc">メッセージの型を指定して、購読しているすべての Actor へ同報配信します</div><div class="ttdef"><b>Definition</b> actor.hpp:135</div></div>
  417. </div><!-- fragment -->
  418. </div>
  419. </div>
  420. <a id="a5549bec310750722a1964de1145b9fed" name="a5549bec310750722a1964de1145b9fed"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#a5549bec310750722a1964de1145b9fed">&#9670;&#160;</a></span>publish() <span class="overload">[2/2]</span></h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="mlabels">
  425. <tr>
  426. <td class="mlabels-left">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname">size_t tk::publish </td>
  430. <td>(</td>
  431. <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>id</em></span>, </td>
  432. </tr>
  433. <tr>
  434. <td class="paramkey"></td>
  435. <td></td>
  436. <td class="paramtype">uintptr_t</td> <td class="paramname"><span class="paramname"><em>arg</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;)</td>
  437. </tr>
  438. </table>
  439. </td>
  440. <td class="mlabels-right">
  441. <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
  442. </tr>
  443. </table>
  444. </div><div class="memdoc">
  445. <p><a class="el" href="structtk_1_1_message.html" title="デフォルトの軽量メッセージ構造体">tk::Message</a> 型の同報配信ショートカット </p>
  446. <dl class="params"><dt>Parameters</dt><dd>
  447. <table class="params">
  448. <tr><td class="paramname">id</td><td>メッセージID </td></tr>
  449. <tr><td class="paramname">arg</td><td>引数 (省略時: 0) </td></tr>
  450. </table>
  451. </dd>
  452. </dl>
  453. <dl class="section return"><dt>Returns</dt><dd>size_t 配信に成功した <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> の数 </dd></dl>
  454. </div>
  455. </div>
  456. <a id="aae83f84121085578a7568437a8dc2447" name="aae83f84121085578a7568437a8dc2447"></a>
  457. <h2 class="memtitle"><span class="permalink"><a href="#aae83f84121085578a7568437a8dc2447">&#9670;&#160;</a></span>sleep_ms()</h2>
  458. <div class="memitem">
  459. <div class="memproto">
  460. <table class="memname">
  461. <tr>
  462. <td class="memname">void tk::sleep_ms </td>
  463. <td>(</td>
  464. <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>ms</em></span></td><td>)</td>
  465. <td></td>
  466. </tr>
  467. </table>
  468. </div><div class="memdoc">
  469. <p>現在のタスクを指定時間スリープさせます </p>
  470. <p>スリープ中はタスクが休止状態になり、CPU は他のタスクへ自動的に割り当てられます (CPU消費ゼロ)。</p>
  471. <dl class="params"><dt>Parameters</dt><dd>
  472. <table class="params">
  473. <tr><td class="paramname">ms</td><td>スリープする時間 (ミリ秒) </td></tr>
  474. </table>
  475. </dd>
  476. </dl>
  477. <dl class="section note"><dt>Note</dt><dd>タスクコンテキスト内から呼び出す必要があります。 </dd></dl>
  478. </div>
  479. </div>
  480. <a id="a675f1829b87e2a43239b6f80a526d0ed" name="a675f1829b87e2a43239b6f80a526d0ed"></a>
  481. <h2 class="memtitle"><span class="permalink"><a href="#a675f1829b87e2a43239b6f80a526d0ed">&#9670;&#160;</a></span>start()</h2>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="memname">
  485. <tr>
  486. <td class="memname">void tk::start </td>
  487. <td>(</td>
  488. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  489. <td></td>
  490. </tr>
  491. </table>
  492. </div><div class="memdoc">
  493. <p>tinykernel スケジューラを起動します </p>
  494. <p>Core 0 のスケジューラを開始し、Core 1 を自動ブートしてデュアルコア並行実行を開始します。 この関数から制御が戻ることはありません (Never returns)。 </p>
  495. </div>
  496. </div>
  497. <a id="a752b12f6862815c94a52347af52578b7" name="a752b12f6862815c94a52347af52578b7"></a>
  498. <h2 class="memtitle"><span class="permalink"><a href="#a752b12f6862815c94a52347af52578b7">&#9670;&#160;</a></span>unlock()</h2>
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname">void tk::unlock </td>
  504. <td>(</td>
  505. <td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>was_enabled</em></span></td><td>)</td>
  506. <td></td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <p><a class="el" href="#a6540aa25eb8562f6d6c8b37977d6cfe8" title="ハードウェアスピンロックと全割り込み禁止によるクリティカルセクションに入ります">tk::lock()</a> で入ったクリティカルセクションを抜けます </p>
  511. <dl class="params"><dt>Parameters</dt><dd>
  512. <table class="params">
  513. <tr><td class="paramname">was_enabled</td><td><a class="el" href="#a6540aa25eb8562f6d6c8b37977d6cfe8" title="ハードウェアスピンロックと全割り込み禁止によるクリティカルセクションに入ります">tk::lock()</a> の戻り値 </td></tr>
  514. </table>
  515. </dd>
  516. </dl>
  517. </div>
  518. </div>
  519. <a id="a8081956b0a19b87d5b7c81b772373397" name="a8081956b0a19b87d5b7c81b772373397"></a>
  520. <h2 class="memtitle"><span class="permalink"><a href="#a8081956b0a19b87d5b7c81b772373397">&#9670;&#160;</a></span>yield()</h2>
  521. <div class="memitem">
  522. <div class="memproto">
  523. <table class="memname">
  524. <tr>
  525. <td class="memname">void tk::yield </td>
  526. <td>(</td>
  527. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  528. <td></td>
  529. </tr>
  530. </table>
  531. </div><div class="memdoc">
  532. <p>現在実行中のタスクを一時中断し、同優先度の他のタスクへ CPU を譲渡します </p>
  533. <dl class="section note"><dt>Note</dt><dd>タスクコンテキスト内から呼び出す必要があります。 </dd></dl>
  534. </div>
  535. </div>
  536. </div><!-- contents -->
  537. </div><!-- doc-content -->
  538. <div id="page-nav" class="page-nav-panel">
  539. <div id="page-nav-resize-handle"></div>
  540. <div id="page-nav-tree">
  541. <div id="page-nav-contents">
  542. </div><!-- page-nav-contents -->
  543. </div><!-- page-nav-tree -->
  544. </div><!-- page-nav -->
  545. </div><!-- container -->
  546. <!-- start footer part -->
  547. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  548. <ul>
  549. <li class="navelem"><a href="namespacetk.html">tk</a></li>
  550. <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>
  551. </ul>
  552. </div>
  553. </body>
  554. </html>