luo980/uvw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
91d6479222
uvw/classuvw_1_1Emitter.html
Michele Caini 91d6479222 api reference
2017-10-11 09:11:53 +02:00

344 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvw: uvw::Emitter&lt; T &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">uvw
&#160;<span id="projectnumber">1.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="classuvw_1_1Emitter.html">Emitter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classuvw_1_1Emitter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uvw::Emitter&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Event emitter base class.
<a href="classuvw_1_1Emitter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for uvw::Emitter&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classuvw_1_1Emitter__inherit__graph.png" border="0" usemap="#uvw_1_1Emitter_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="uvw_1_1Emitter_3_01T_01_4_inherit__map" id="uvw_1_1Emitter_3_01T_01_4_inherit__map">
<area shape="rect" id="node2" href="classuvw_1_1Resource.html" title="Resource\&lt; T, uv_fs_t \&gt;" alt="" coords="5,80,167,107"/>
<area shape="rect" id="node3" href="classuvw_1_1Resource.html" title="Common class for almost all the resources available in uvw. " alt="" coords="191,80,333,107"/>
<area shape="rect" id="node4" href="classuvw_1_1Handle.html" title="Handle base class. " alt="" coords="189,155,335,181"/>
<area shape="rect" id="node5" href="classuvw_1_1StreamHandle.html" title="The StreamHandle handle. " alt="" coords="189,229,335,271"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structuvw_1_1Emitter_1_1Connection.html" title="Connection type for a given event type. ">Connection</a> type for a given event type. <a href="structuvw_1_1Emitter_1_1Connection.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af6ba3eecb542efbef8d62ae905d8a8cd"><td class="memTemplParams" colspan="2">template&lt;typename E &gt; </td></tr>
<tr class="memitem:af6ba3eecb542efbef8d62ae905d8a8cd"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a>&lt; E &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#af6ba3eecb542efbef8d62ae905d8a8cd">on</a> (Listener&lt; E &gt; f)</td></tr>
<tr class="memdesc:af6ba3eecb542efbef8d62ae905d8a8cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a long-lived listener with the event emitter. <a href="#af6ba3eecb542efbef8d62ae905d8a8cd">More...</a><br /></td></tr>
<tr class="separator:af6ba3eecb542efbef8d62ae905d8a8cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79e4ed59b5bb5cdc5ee4b0dd71a38472"><td class="memTemplParams" colspan="2">template&lt;typename E &gt; </td></tr>
<tr class="memitem:a79e4ed59b5bb5cdc5ee4b0dd71a38472"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a>&lt; E &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a79e4ed59b5bb5cdc5ee4b0dd71a38472">once</a> (Listener&lt; E &gt; f)</td></tr>
<tr class="memdesc:a79e4ed59b5bb5cdc5ee4b0dd71a38472"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a short-lived listener with the event emitter. <a href="#a79e4ed59b5bb5cdc5ee4b0dd71a38472">More...</a><br /></td></tr>
<tr class="separator:a79e4ed59b5bb5cdc5ee4b0dd71a38472"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c98ab223b4367073d96c51ee3d6a0d1"><td class="memTemplParams" colspan="2">template&lt;typename E &gt; </td></tr>
<tr class="memitem:a4c98ab223b4367073d96c51ee3d6a0d1"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a4c98ab223b4367073d96c51ee3d6a0d1">erase</a> (<a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a>&lt; E &gt; conn) noexcept</td></tr>
<tr class="memdesc:a4c98ab223b4367073d96c51ee3d6a0d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a listener from the event emitter. <a href="#a4c98ab223b4367073d96c51ee3d6a0d1">More...</a><br /></td></tr>
<tr class="separator:a4c98ab223b4367073d96c51ee3d6a0d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d332776a2e35049549a723f35d88912"><td class="memTemplParams" colspan="2"><a id="a3d332776a2e35049549a723f35d88912"></a>
template&lt;typename E &gt; </td></tr>
<tr class="memitem:a3d332776a2e35049549a723f35d88912"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a3d332776a2e35049549a723f35d88912">clear</a> () noexcept</td></tr>
<tr class="memdesc:a3d332776a2e35049549a723f35d88912"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects all the listeners for the given event type. <br /></td></tr>
<tr class="separator:a3d332776a2e35049549a723f35d88912"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ff321dde35550bb40ab90a787b715cf"><td class="memItemLeft" align="right" valign="top"><a id="a6ff321dde35550bb40ab90a787b715cf"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a6ff321dde35550bb40ab90a787b715cf">clear</a> () noexcept</td></tr>
<tr class="memdesc:a6ff321dde35550bb40ab90a787b715cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects all the listeners. <br /></td></tr>
<tr class="separator:a6ff321dde35550bb40ab90a787b715cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2178cfdcc8b19baa6d7e1f950c7b65c4"><td class="memTemplParams" colspan="2">template&lt;typename E &gt; </td></tr>
<tr class="memitem:a2178cfdcc8b19baa6d7e1f950c7b65c4"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a2178cfdcc8b19baa6d7e1f950c7b65c4">empty</a> () const noexcept</td></tr>
<tr class="memdesc:a2178cfdcc8b19baa6d7e1f950c7b65c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if there are listeners registered for the specific event. <a href="#a2178cfdcc8b19baa6d7e1f950c7b65c4">More...</a><br /></td></tr>
<tr class="separator:a2178cfdcc8b19baa6d7e1f950c7b65c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af15516ea3df907e5e27512d05f64a1cd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#af15516ea3df907e5e27512d05f64a1cd">empty</a> () const noexcept</td></tr>
<tr class="memdesc:af15516ea3df907e5e27512d05f64a1cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if there are listeners registered with the event emitter. <a href="#af15516ea3df907e5e27512d05f64a1cd">More...</a><br /></td></tr>
<tr class="separator:af15516ea3df907e5e27512d05f64a1cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br />
class uvw::Emitter&lt; T &gt;</h3>
<p>Event emitter base class. </p>
<p>Almost everything in <code>uvw</code> is an event emitter.<br />
This is the base class from which resources and loops inherit. </p>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00087">87</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2178cfdcc8b19baa6d7e1f950c7b65c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2178cfdcc8b19baa6d7e1f950c7b65c4">&#9670;&nbsp;</a></span>empty() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<div class="memtemplate">
template&lt;typename E &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classuvw_1_1Emitter.html">uvw::Emitter</a>&lt; T &gt;::empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if there are listeners registered for the specific event. </p>
<dl class="section return"><dt>Returns</dt><dd>True if there are no listeners registered for the specific event, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00295">295</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="af15516ea3df907e5e27512d05f64a1cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af15516ea3df907e5e27512d05f64a1cd">&#9670;&nbsp;</a></span>empty() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classuvw_1_1Emitter.html">uvw::Emitter</a>&lt; T &gt;::empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if there are listeners registered with the event emitter. </p>
<dl class="section return"><dt>Returns</dt><dd>True if there are no listeners registered with the event emitter, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00308">308</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a4c98ab223b4367073d96c51ee3d6a0d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c98ab223b4367073d96c51ee3d6a0d1">&#9670;&nbsp;</a></span>erase()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<div class="memtemplate">
template&lt;typename E &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classuvw_1_1Emitter.html">uvw::Emitter</a>&lt; T &gt;::erase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a>&lt; E &gt;&#160;</td>
<td class="paramname"><em>conn</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnects a listener from the event emitter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">conn</td><td>A valid <a class="el" href="structuvw_1_1Emitter_1_1Connection.html" title="Connection type for a given event type. ">Connection</a> object </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00269">269</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="af6ba3eecb542efbef8d62ae905d8a8cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6ba3eecb542efbef8d62ae905d8a8cd">&#9670;&nbsp;</a></span>on()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<div class="memtemplate">
template&lt;typename E &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a>&lt;E&gt; <a class="el" href="classuvw_1_1Emitter.html">uvw::Emitter</a>&lt; T &gt;::on </td>
<td>(</td>
<td class="paramtype">Listener&lt; E &gt;&#160;</td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a long-lived listener with the event emitter. </p>
<p>This method can be used to register a listener that is meant to be invoked more than once for the given event type.<br />
The <a class="el" href="structuvw_1_1Emitter_1_1Connection.html" title="Connection type for a given event type. ">Connection</a> object returned by the method can be freely discarded. It can be used later to disconnect the listener, if needed.</p>
<p>Listener is usually defined as a callable object assignable to a <code>std::function&lt;void(const E &amp;, T &amp;)</code>, where <code>E</code> is the type of the event and <code>T</code> is the type of the resource.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>A valid listener to be registered. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structuvw_1_1Emitter_1_1Connection.html" title="Connection type for a given event type. ">Connection</a> object to be used later to disconnect the listener. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00240">240</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a79e4ed59b5bb5cdc5ee4b0dd71a38472"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79e4ed59b5bb5cdc5ee4b0dd71a38472">&#9670;&nbsp;</a></span>once()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<div class="memtemplate">
template&lt;typename E &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a>&lt;E&gt; <a class="el" href="classuvw_1_1Emitter.html">uvw::Emitter</a>&lt; T &gt;::once </td>
<td>(</td>
<td class="paramtype">Listener&lt; E &gt;&#160;</td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a short-lived listener with the event emitter. </p>
<p>This method can be used to register a listener that is meant to be invoked only once for the given event type.<br />
The <a class="el" href="structuvw_1_1Emitter_1_1Connection.html" title="Connection type for a given event type. ">Connection</a> object returned by the method can be freely discarded. It can be used later to disconnect the listener, if needed.</p>
<p>Listener is usually defined as a callable object assignable to a <code>std::function&lt;void(const E &amp;, T &amp;)</code>, where <code>E</code> is the type of the event and <code>T</code> is the type of the resource.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>Avalid listener to be registered. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structuvw_1_1Emitter_1_1Connection.html" title="Connection type for a given event type. ">Connection</a> object to be used later to disconnect the listener. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00260">260</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/uvw/<a class="el" href="emitter_8hpp_source.html">emitter.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink