Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4594898b8e232451e3854cedc4202b0b4e96861c
entt/classentt_1_1Scheduler.html
Michele Caini 4594898b8e API reference v2.7.1
2018-07-10 16:37:27 +02:00

522 lines
30 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>entt: entt::Scheduler&lt; Delta &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">entt
&#160;<span id="projectnumber">2.7.1</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="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1Scheduler.html">Scheduler</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classentt_1_1Scheduler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::Scheduler&lt; Delta &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Cooperative scheduler for processes.
<a href="classentt_1_1Scheduler.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>&gt;</code></p>
<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:a2d76dbf324cf960ac8f2fc6d87d40eba"><td class="memItemLeft" align="right" valign="top"><a id="a2d76dbf324cf960ac8f2fc6d87d40eba"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#a2d76dbf324cf960ac8f2fc6d87d40eba">size_type</a> = typename std::vector&lt; ProcessHandler &gt;::<a class="el" href="classentt_1_1Scheduler.html#a2d76dbf324cf960ac8f2fc6d87d40eba">size_type</a></td></tr>
<tr class="memdesc:a2d76dbf324cf960ac8f2fc6d87d40eba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:a2d76dbf324cf960ac8f2fc6d87d40eba"><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:a9c8baf08ea6f2869432cb13d870481c3"><td class="memItemLeft" align="right" valign="top"><a id="a9c8baf08ea6f2869432cb13d870481c3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#a9c8baf08ea6f2869432cb13d870481c3">Scheduler</a> () ENTT_NOEXCEPT=default</td></tr>
<tr class="memdesc:a9c8baf08ea6f2869432cb13d870481c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a9c8baf08ea6f2869432cb13d870481c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4527dc6d1aedb50126e522ae7c8de5a1"><td class="memItemLeft" align="right" valign="top"><a id="a4527dc6d1aedb50126e522ae7c8de5a1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#a4527dc6d1aedb50126e522ae7c8de5a1">Scheduler</a> (const <a class="el" href="classentt_1_1Scheduler.html">Scheduler</a> &amp;)=delete</td></tr>
<tr class="memdesc:a4527dc6d1aedb50126e522ae7c8de5a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copying a scheduler isn't allowed. <br /></td></tr>
<tr class="separator:a4527dc6d1aedb50126e522ae7c8de5a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3a3ca9fa457fd48873c6d0d700a6f6c"><td class="memItemLeft" align="right" valign="top"><a id="ab3a3ca9fa457fd48873c6d0d700a6f6c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#ab3a3ca9fa457fd48873c6d0d700a6f6c">Scheduler</a> (<a class="el" href="classentt_1_1Scheduler.html">Scheduler</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:ab3a3ca9fa457fd48873c6d0d700a6f6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move constructor. <br /></td></tr>
<tr class="separator:ab3a3ca9fa457fd48873c6d0d700a6f6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66fa731504da02dfaa607e1c3f153120"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#a66fa731504da02dfaa607e1c3f153120">operator=</a> (const <a class="el" href="classentt_1_1Scheduler.html">Scheduler</a> &amp;)=delete</td></tr>
<tr class="memdesc:a66fa731504da02dfaa607e1c3f153120"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copying a scheduler isn't allowed. <a href="#a66fa731504da02dfaa607e1c3f153120">More...</a><br /></td></tr>
<tr class="separator:a66fa731504da02dfaa607e1c3f153120"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a929ec57792af25f0552f25ad445c7731"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#a929ec57792af25f0552f25ad445c7731">operator=</a> (<a class="el" href="classentt_1_1Scheduler.html">Scheduler</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a929ec57792af25f0552f25ad445c7731"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator. <a href="#a929ec57792af25f0552f25ad445c7731">More...</a><br /></td></tr>
<tr class="separator:a929ec57792af25f0552f25ad445c7731"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59aea2fac213df785278870474a3abb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1Scheduler.html#a2d76dbf324cf960ac8f2fc6d87d40eba">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#a59aea2fac213df785278870474a3abb5">size</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a59aea2fac213df785278870474a3abb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of processes currently scheduled. <a href="#a59aea2fac213df785278870474a3abb5">More...</a><br /></td></tr>
<tr class="separator:a59aea2fac213df785278870474a3abb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba0da7c946d76561a8694ecf7c5b29e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#aba0da7c946d76561a8694ecf7c5b29e3">empty</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:aba0da7c946d76561a8694ecf7c5b29e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if at least a process is currently scheduled. <a href="#aba0da7c946d76561a8694ecf7c5b29e3">More...</a><br /></td></tr>
<tr class="separator:aba0da7c946d76561a8694ecf7c5b29e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fd48cfd2ce32308f5e7bb8bafd5cda2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#a2fd48cfd2ce32308f5e7bb8bafd5cda2">clear</a> ()</td></tr>
<tr class="memdesc:a2fd48cfd2ce32308f5e7bb8bafd5cda2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Discards all scheduled processes. <a href="#a2fd48cfd2ce32308f5e7bb8bafd5cda2">More...</a><br /></td></tr>
<tr class="separator:a2fd48cfd2ce32308f5e7bb8bafd5cda2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a836000f65e8e275119c0f77ec46674"><td class="memTemplParams" colspan="2">template&lt;typename Proc , typename... Args&gt; </td></tr>
<tr class="memitem:a1a836000f65e8e275119c0f77ec46674"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#a1a836000f65e8e275119c0f77ec46674">attach</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:a1a836000f65e8e275119c0f77ec46674"><td class="mdescLeft">&#160;</td><td class="mdescRight">Schedules a process for the next tick. <a href="#a1a836000f65e8e275119c0f77ec46674">More...</a><br /></td></tr>
<tr class="separator:a1a836000f65e8e275119c0f77ec46674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5915b9783b278a6006d4857feefc0e3b"><td class="memTemplParams" colspan="2">template&lt;typename Func &gt; </td></tr>
<tr class="memitem:a5915b9783b278a6006d4857feefc0e3b"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#a5915b9783b278a6006d4857feefc0e3b">attach</a> (Func &amp;&amp;func)</td></tr>
<tr class="memdesc:a5915b9783b278a6006d4857feefc0e3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Schedules a process for the next tick. <a href="#a5915b9783b278a6006d4857feefc0e3b">More...</a><br /></td></tr>
<tr class="separator:a5915b9783b278a6006d4857feefc0e3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff001b4bf5aaa53fe1fda94991e73935"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#aff001b4bf5aaa53fe1fda94991e73935">update</a> (const Delta delta, void *data=nullptr)</td></tr>
<tr class="memdesc:aff001b4bf5aaa53fe1fda94991e73935"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates all scheduled processes. <a href="#aff001b4bf5aaa53fe1fda94991e73935">More...</a><br /></td></tr>
<tr class="separator:aff001b4bf5aaa53fe1fda94991e73935"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2494e025703d03a87117d6e897c87db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Scheduler.html#af2494e025703d03a87117d6e897c87db">abort</a> (const bool immediately=false)</td></tr>
<tr class="memdesc:af2494e025703d03a87117d6e897c87db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Aborts all scheduled processes. <a href="#af2494e025703d03a87117d6e897c87db">More...</a><br /></td></tr>
<tr class="separator:af2494e025703d03a87117d6e897c87db"><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 Delta&gt;<br />
class entt::Scheduler&lt; Delta &gt;</h3>
<p>Cooperative scheduler for processes. </p>
<p>A cooperative scheduler runs processes and helps managing their life cycles.</p>
<p>Each process is invoked once per tick. If a process terminates, it's removed automatically from the scheduler and it's never invoked again.<br />
A process can also have a child. In this case, the process is replaced with its child when it terminates if it returns with success. In case of errors, both the process and its child are discarded.</p>
<p>Example of use (pseudocode):</p>
<div class="fragment"><div class="line">scheduler.attach([](<span class="keyword">auto</span> delta, <span class="keywordtype">void</span> *, <span class="keyword">auto</span> succeed, <span class="keyword">auto</span> fail) {</div><div class="line"> <span class="comment">// code</span></div><div class="line">}).then&lt;MyProcess&gt;(arguments...);</div></div><!-- fragment --><p>In order to invoke all scheduled processes, call the <code>update</code> member function passing it the elapsed time to forward to the tasks.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1Process.html" title="Base class for processes. ">Process</a></dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Delta</td><td>Type to use to provide elapsed time. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00044">44</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af2494e025703d03a87117d6e897c87db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2494e025703d03a87117d6e897c87db">&#9670;&nbsp;</a></span>abort()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1Scheduler.html">entt::Scheduler</a>&lt; Delta &gt;::abort </td>
<td>(</td>
<td class="paramtype">const bool&#160;</td>
<td class="paramname"><em>immediately</em> = <code>false</code></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>Aborts all scheduled processes. </p>
<p>Unless an immediate operation is requested, the abort is scheduled for the next tick. Processes won't be executed anymore in any case.<br />
Once a process is fully aborted and thus finished, it's discarded along with its child, if any.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">immediately</td><td>Requests an immediate operation. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00291">291</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
</div>
</div>
<a id="a1a836000f65e8e275119c0f77ec46674"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a836000f65e8e275119c0f77ec46674">&#9670;&nbsp;</a></span>attach() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Delta &gt; </div>
<div class="memtemplate">
template&lt;typename Proc , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="classentt_1_1Scheduler.html">entt::Scheduler</a>&lt; Delta &gt;::attach </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</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>Schedules a process for the next tick. </p>
<p>Returned value is an opaque object that can be used to attach a child to the given process. The child is automatically scheduled when the process terminates and only if the process returns with success.</p>
<p>Example of use (pseudocode):</p>
<div class="fragment"><div class="line"><span class="comment">// schedules a task in the form of a process class</span></div><div class="line">scheduler.attach&lt;MyProcess&gt;(arguments...)</div><div class="line"><span class="comment">// appends a child in the form of a lambda function</span></div><div class="line">.then([](<span class="keyword">auto</span> delta, <span class="keywordtype">void</span> *, <span class="keyword">auto</span> succeed, <span class="keyword">auto</span> fail) {</div><div class="line"> <span class="comment">// code</span></div><div class="line">})</div><div class="line"><span class="comment">// appends a child in the form of another process class</span></div><div class="line">.then&lt;MyOtherProcess&gt;();</div></div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Proc</td><td>Type of process to schedule. </td></tr>
<tr><td class="paramname">Args</td><td>Types of arguments to use to initialize the process. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to initialize the process. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An opaque object to use to concatenate processes. </dd></dl>
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00188">188</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
</div>
</div>
<a id="a5915b9783b278a6006d4857feefc0e3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5915b9783b278a6006d4857feefc0e3b">&#9670;&nbsp;</a></span>attach() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Delta &gt; </div>
<div class="memtemplate">
template&lt;typename Func &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="classentt_1_1Scheduler.html">entt::Scheduler</a>&lt; Delta &gt;::attach </td>
<td>(</td>
<td class="paramtype">Func &amp;&amp;&#160;</td>
<td class="paramname"><em>func</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>Schedules a process for the next tick. </p>
<p>A process can be either a lambda or a functor. The scheduler wraps both of them in a process adaptor internally.<br />
The signature of the function call operator should be equivalent to the following:</p>
<div class="fragment"><div class="line">void(Delta delta, <span class="keyword">auto</span> succeed, <span class="keyword">auto</span> fail);</div></div><!-- fragment --><p>Where:</p>
<ul>
<li><code>delta</code> is the elapsed time.</li>
<li><code>succeed</code> is a function to call when a process terminates with success.</li>
<li><code>fail</code> is a function to call when a process terminates with errors.</li>
</ul>
<p>The signature of the function call operator of both <code>succeed</code> and <code>fail</code> is equivalent to the following:</p>
<div class="fragment"><div class="line">void();</div></div><!-- fragment --><p>Returned value is an opaque object that can be used to attach a child to the given process. The child is automatically scheduled when the process terminates and only if the process returns with success.</p>
<p>Example of use (pseudocode):</p>
<div class="fragment"><div class="line"><span class="comment">// schedules a task in the form of a lambda function</span></div><div class="line">scheduler.attach([](<span class="keyword">auto</span> delta, <span class="keywordtype">void</span> *, <span class="keyword">auto</span> succeed, <span class="keyword">auto</span> fail) {</div><div class="line"> <span class="comment">// code</span></div><div class="line">})</div><div class="line"><span class="comment">// appends a child in the form of another lambda function</span></div><div class="line">.then([](<span class="keyword">auto</span> delta, <span class="keywordtype">void</span> *, <span class="keyword">auto</span> succeed, <span class="keyword">auto</span> fail) {</div><div class="line"> <span class="comment">// code</span></div><div class="line">})</div><div class="line"><span class="comment">// appends a child in the form of a process class</span></div><div class="line">.then&lt;MyProcess&gt;(arguments...);</div></div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="structentt_1_1ProcessAdaptor.html" title="Adaptor for lambdas and functors to turn them into processes. ">ProcessAdaptor</a></dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Func</td><td>Type of process to schedule. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>Either a lambda or a functor to use as a process. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An opaque object to use to concatenate processes. </dd></dl>
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00249">249</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
</div>
</div>
<a id="a2fd48cfd2ce32308f5e7bb8bafd5cda2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fd48cfd2ce32308f5e7bb8bafd5cda2">&#9670;&nbsp;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1Scheduler.html">entt::Scheduler</a>&lt; Delta &gt;::clear </td>
<td>(</td>
<td class="paramname"></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>Discards all scheduled processes. </p>
<p>Processes aren't aborted. They are discarded along with their children and never executed again. </p>
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00158">158</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
</div>
</div>
<a id="aba0da7c946d76561a8694ecf7c5b29e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba0da7c946d76561a8694ecf7c5b29e3">&#9670;&nbsp;</a></span>empty()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1Scheduler.html">entt::Scheduler</a>&lt; Delta &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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if at least a process is currently scheduled. </p>
<dl class="section return"><dt>Returns</dt><dd>True if there are scheduled processes, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00148">148</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
</div>
</div>
<a id="a66fa731504da02dfaa607e1c3f153120"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66fa731504da02dfaa607e1c3f153120">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1Scheduler.html">Scheduler</a>&amp; <a class="el" href="classentt_1_1Scheduler.html">entt::Scheduler</a>&lt; Delta &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1Scheduler.html">Scheduler</a>&lt; Delta &gt; &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copying a scheduler isn't allowed. </p>
<dl class="section return"><dt>Returns</dt><dd>This scheduler. </dd></dl>
</div>
</div>
<a id="a929ec57792af25f0552f25ad445c7731"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a929ec57792af25f0552f25ad445c7731">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1Scheduler.html">Scheduler</a>&amp; <a class="el" href="classentt_1_1Scheduler.html">entt::Scheduler</a>&lt; Delta &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1Scheduler.html">Scheduler</a>&lt; Delta &gt; &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default move assignment operator. </p>
<dl class="section return"><dt>Returns</dt><dd>This scheduler. </dd></dl>
</div>
</div>
<a id="a59aea2fac213df785278870474a3abb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59aea2fac213df785278870474a3abb5">&#9670;&nbsp;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1Scheduler.html#a2d76dbf324cf960ac8f2fc6d87d40eba">size_type</a> <a class="el" href="classentt_1_1Scheduler.html">entt::Scheduler</a>&lt; Delta &gt;::size </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of processes currently scheduled. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of processes currently scheduled. </dd></dl>
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00140">140</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
</div>
</div>
<a id="aff001b4bf5aaa53fe1fda94991e73935"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff001b4bf5aaa53fe1fda94991e73935">&#9670;&nbsp;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1Scheduler.html">entt::Scheduler</a>&lt; Delta &gt;::update </td>
<td>(</td>
<td class="paramtype">const Delta&#160;</td>
<td class="paramname"><em>delta</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>data</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Updates all scheduled processes. </p>
<p>All scheduled processes are executed in no specific order.<br />
If a process terminates with success, it's replaced with its child, if any. Otherwise, if a process terminates with an error, it's removed along with its child.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delta</td><td>Elapsed time. </td></tr>
<tr><td class="paramname">data</td><td>Optional data. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00265">265</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/entt/process/<a class="el" href="scheduler_8hpp_source.html">scheduler.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