tinykernel/docs/html/classtk_1_1_event_hub.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::EventHub&lt; MsgType, MaxSubscribers &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_event_hub.html','','classtk_1_1_event_hub-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::EventHub&lt; MsgType, MaxSubscribers &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p>メッセージ型ごとの超軽量 Pub/Sub ディスパッチャ  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="actor_8hpp_source.html">actor.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-static-methods" class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a50ebe29eaa2657604a1c85bf5125d490" id="r_a50ebe29eaa2657604a1c85bf5125d490"><td class="memItemLeft">static bool&#160;</td><td class="memItemRight"><a class="el" href="#a50ebe29eaa2657604a1c85bf5125d490">subscribe</a> (void *actor, bool(*post_fn)(void *, const MsgType &amp;))</td></tr>
<tr class="memdesc:a50ebe29eaa2657604a1c85bf5125d490"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> をこのメッセージ型の購読者として登録します  <br /></td></tr>
<tr class="memitem:a09c779ce8c594ea44c831adfd7e287f8" id="r_a09c779ce8c594ea44c831adfd7e287f8"><td class="memItemLeft">static bool&#160;</td><td class="memItemRight"><a class="el" href="#a09c779ce8c594ea44c831adfd7e287f8">unsubscribe</a> (void *actor)</td></tr>
<tr class="memdesc:a09c779ce8c594ea44c831adfd7e287f8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> の購読登録を解除します  <br /></td></tr>
<tr class="memitem:a3a59a641ad3fe121c0da7e1c81dc300b" id="r_a3a59a641ad3fe121c0da7e1c81dc300b"><td class="memItemLeft">static size_t&#160;</td><td class="memItemRight"><a class="el" href="#a3a59a641ad3fe121c0da7e1c81dc300b">publish</a> (const MsgType &amp;msg)</td></tr>
<tr class="memdesc:a3a59a641ad3fe121c0da7e1c81dc300b"><td class="mdescLeft">&#160;</td><td class="mdescRight">このメッセージ型を購読しているすべての <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> へ同報配信します  <br /></td></tr>
<tr class="memitem:ac4cd6ce4e37b74385c7f4352a5516930" id="r_ac4cd6ce4e37b74385c7f4352a5516930"><td class="memItemLeft">static size_t&#160;</td><td class="memItemRight"><a class="el" href="#ac4cd6ce4e37b74385c7f4352a5516930">subscriber_count</a> ()</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 MsgType, size_t MaxSubscribers = 4&gt;<br />
class tk::EventHub&lt; MsgType, MaxSubscribers &gt;</div><p>メッセージ型ごとの超軽量 Pub/Sub ディスパッチャ </p>
<p>テンプレート引数 <span class="tt">MsgType</span> ごとにコンパイル時解決される静的レジストリです。 実行時の型検索オーバーヘッドゼロ、動的メモリ確保ゼロで動作します。</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">MsgType</td><td>配信するメッセージの型 </td></tr>
    <tr><td class="paramname">MaxSubscribers</td><td>同一メッセージ型を購読できる最大 <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> 数 (デフォルト: 4) </td></tr>
  </table>
  </dd>
</dl>
</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="a3a59a641ad3fe121c0da7e1c81dc300b" name="a3a59a641ad3fe121c0da7e1c81dc300b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a59a641ad3fe121c0da7e1c81dc300b">&#9670;&#160;</a></span>publish()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MsgType, size_t MaxSubscribers = 4&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">size_t <a class="el" href="classtk_1_1_event_hub.html">tk::EventHub</a>&lt; MsgType, MaxSubscribers &gt;::publish </td>
          <td>(</td>
          <td class="paramtype">const MsgType &amp;</td>          <td class="paramname"><span class="paramname"><em>msg</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 static">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>このメッセージ型を購読しているすべての <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> へ同報配信します </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msg</td><td>配信するメッセージ実体 (各 <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> のキューへ値コピー) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size_t 配信に成功した <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> の数 </dd></dl>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MsgType, size_t MaxSubscribers = 4&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classtk_1_1_event_hub.html">tk::EventHub</a>&lt; MsgType, MaxSubscribers &gt;::subscribe </td>
          <td>(</td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>actor</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool(*</td>          <td class="paramname"><span class="paramname"><em>post_fn&#160;</em></span>)(void *, const MsgType &amp;)&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> をこのメッセージ型の購読者として登録します </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">actor</td><td><a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> インスタンスポインタ </td></tr>
    <tr><td class="paramname">post_fn</td><td>メッセージ投入関数ポインタ </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true 登録成功, false 購読者上限に達した </dd></dl>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MsgType, size_t MaxSubscribers = 4&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">size_t <a class="el" href="classtk_1_1_event_hub.html">tk::EventHub</a>&lt; MsgType, MaxSubscribers &gt;::subscriber_count </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 class="mlabel static">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>現在の購読者数を取得 </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MsgType, size_t MaxSubscribers = 4&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classtk_1_1_event_hub.html">tk::EventHub</a>&lt; MsgType, MaxSubscribers &gt;::unsubscribe </td>
          <td>(</td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>actor</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 static">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> の購読登録を解除します </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">actor</td><td>解除する <a class="el" href="classtk_1_1_actor.html" title="メッセージ駆動型タスク (アクター) の基底クラス">Actor</a> インスタンスポインタ </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true 解除成功, 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="actor_8hpp_source.html">actor.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_event_hub.html">EventHub</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>