<!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"> <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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libfilezilla: simple_event< UniqueType, Values > 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="projectlogo"><img alt="Logo" src="libfilezilla.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libfilezilla </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</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="namespacefz.html">fz</a></li><li class="navelem"><a class="el" href="classfz_1_1simple__event.html">simple_event</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="classfz_1_1simple__event-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">simple_event< UniqueType, Values > Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div> </div><!--header--> <div class="contents"> <p>This is the recommended event class. <a href="classfz_1_1simple__event.html#details">More...</a></p> <p><code>#include <<a class="el" href="event_8hpp_source.html">event.hpp</a>></code></p> <div class="dynheader"> Inheritance diagram for simple_event< UniqueType, Values >:</div> <div class="dyncontent"> <div class="center"><img src="classfz_1_1simple__event__inherit__graph.png" border="0" usemap="#simple__event_3_01UniqueType_00_01Values_01_4_inherit__map" alt="Inheritance graph"/></div> <map name="simple__event_3_01UniqueType_00_01Values_01_4_inherit__map" id="simple__event_3_01UniqueType_00_01Values_01_4_inherit__map"> <area shape="rect" title="This is the recommended event class." alt="" coords="5,80,195,121"/> <area shape="rect" href="classfz_1_1event__base.html" title="Common base class for all events." alt="" coords="55,5,145,32"/> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for simple_event< UniqueType, Values >:</div> <div class="dyncontent"> <div class="center"><img src="classfz_1_1simple__event__coll__graph.png" border="0" usemap="#simple__event_3_01UniqueType_00_01Values_01_4_coll__map" alt="Collaboration graph"/></div> <map name="simple__event_3_01UniqueType_00_01Values_01_4_coll__map" id="simple__event_3_01UniqueType_00_01Values_01_4_coll__map"> <area shape="rect" title="This is the recommended event class." alt="" coords="5,80,195,121"/> <area shape="rect" href="classfz_1_1event__base.html" title="Common base class for all events." alt="" coords="55,5,145,32"/> </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="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a68aa25517a78d5f61ae1c54abb6f1c38"><td class="memItemLeft" align="right" valign="top"><a id="a68aa25517a78d5f61ae1c54abb6f1c38"></a> typedef UniqueType </td><td class="memItemRight" valign="bottom"><b>unique_type</b></td></tr> <tr class="separator:a68aa25517a78d5f61ae1c54abb6f1c38"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d8222c9e5bca360325c607a3696a976"><td class="memItemLeft" align="right" valign="top"><a id="a1d8222c9e5bca360325c607a3696a976"></a> typedef std::tuple< Values... > </td><td class="memItemRight" valign="bottom"><b>tuple_type</b></td></tr> <tr class="separator:a1d8222c9e5bca360325c607a3696a976"><td class="memSeparator" colspan="2"> </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:a1afd9442f85e5a7b9ab546d7d8404d42"><td class="memTemplParams" colspan="2"><a id="a1afd9442f85e5a7b9ab546d7d8404d42"></a> template<typename First_Value , typename... Remaining_Values> </td></tr> <tr class="memitem:a1afd9442f85e5a7b9ab546d7d8404d42"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>simple_event</b> (First_Value &&value, Remaining_Values &&...values)</td></tr> <tr class="separator:a1afd9442f85e5a7b9ab546d7d8404d42"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0285b29a915588947e2bd5064840eb99"><td class="memItemLeft" align="right" valign="top"><a id="a0285b29a915588947e2bd5064840eb99"></a>  </td><td class="memItemRight" valign="bottom"><b>simple_event</b> (<a class="el" href="classfz_1_1simple__event.html">simple_event</a> const &op)=default</td></tr> <tr class="separator:a0285b29a915588947e2bd5064840eb99"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6e1baac5260390c703a8fea1a80237e5"><td class="memItemLeft" align="right" valign="top"><a id="a6e1baac5260390c703a8fea1a80237e5"></a> <a class="el" href="classfz_1_1simple__event.html">simple_event</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfz_1_1simple__event.html">simple_event</a> const &op)=default</td></tr> <tr class="separator:a6e1baac5260390c703a8fea1a80237e5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a972fb5146fcc0d89081dda8484b7fc7d"><td class="memItemLeft" align="right" valign="top"><a id="a972fb5146fcc0d89081dda8484b7fc7d"></a> virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1simple__event.html#a972fb5146fcc0d89081dda8484b7fc7d">derived_type</a> () const</td></tr> <tr class="memdesc:a972fb5146fcc0d89081dda8484b7fc7d"><td class="mdescLeft"> </td><td class="mdescRight">Simply returns <a class="el" href="classfz_1_1simple__event.html#af31e076dbdba76448e11562c858de1c5">type()</a> <br /></td></tr> <tr class="separator:a972fb5146fcc0d89081dda8484b7fc7d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classfz_1_1event__base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfz_1_1event__base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classfz_1_1event__base.html">event_base</a></td></tr> <tr class="memitem:aa4d3f7a0ced08f75007298282d57c922 inherit pub_methods_classfz_1_1event__base"><td class="memItemLeft" align="right" valign="top"><a id="aa4d3f7a0ced08f75007298282d57c922"></a>  </td><td class="memItemRight" valign="bottom"><b>event_base</b> (<a class="el" href="classfz_1_1event__base.html">event_base</a> const &)=delete</td></tr> <tr class="separator:aa4d3f7a0ced08f75007298282d57c922 inherit pub_methods_classfz_1_1event__base"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1ef021d577ef05af75dd96f5a845babc inherit pub_methods_classfz_1_1event__base"><td class="memItemLeft" align="right" valign="top"><a id="a1ef021d577ef05af75dd96f5a845babc"></a> <a class="el" href="classfz_1_1event__base.html">event_base</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfz_1_1event__base.html">event_base</a> const &)=delete</td></tr> <tr class="separator:a1ef021d577ef05af75dd96f5a845babc inherit pub_methods_classfz_1_1event__base"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:af31e076dbdba76448e11562c858de1c5"><td class="memItemLeft" align="right" valign="top"><a id="af31e076dbdba76448e11562c858de1c5"></a> static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1simple__event.html#af31e076dbdba76448e11562c858de1c5">type</a> ()</td></tr> <tr class="memdesc:af31e076dbdba76448e11562c858de1c5"><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique id for the type such that can be used directly in derived_type. <br /></td></tr> <tr class="separator:af31e076dbdba76448e11562c858de1c5"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:a0e36079456f4da6cd991ae3880bd15c6"><td class="memItemLeft" align="right" valign="top">tuple_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1simple__event.html#a0e36079456f4da6cd991ae3880bd15c6">v_</a></td></tr> <tr class="memdesc:a0e36079456f4da6cd991ae3880bd15c6"><td class="mdescLeft"> </td><td class="mdescRight">The event value, gets built from the arguments passed in the constructur. <a href="#a0e36079456f4da6cd991ae3880bd15c6">More...</a><br /></td></tr> <tr class="separator:a0e36079456f4da6cd991ae3880bd15c6"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<typename UniqueType, typename... Values><br /> class fz::simple_event< UniqueType, Values ></h3> <p>This is the recommended event class. </p> <p>Instanciate the template with a unique type to identify the type of the event and a number of types for the values.</p> <p>Keep the values simple, in particular avoid mutexes in your values.</p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="classfz_1_1event__handler.html" title="Simple handler for asynchronous event processing.">event_handler</a> for usage example. </dd></dl> <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="events_8cpp-example.html#_a2">events.cpp</a>, and <a class="el" href="timer_fizzbuzz_8cpp-example.html#_a0">timer_fizzbuzz.cpp</a>.</dd> </dl> </div><h2 class="groupheader">Member Data Documentation</h2> <a id="a0e36079456f4da6cd991ae3880bd15c6"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0e36079456f4da6cd991ae3880bd15c6">◆ </a></span>v_</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">tuple_type v_</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">mutable</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>The event value, gets built from the arguments passed in the constructur. </p> <p>You don't need to access this member directly if you use the <a class="el" href="namespacefz.html#a4d4a08f8e7594ee417a8c89565f9685b">dispatch</a> mechanism. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="event_8hpp_source.html">event.hpp</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>