964 lines
56 KiB
HTML
964 lines
56 KiB
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.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::basic_scheduler< Delta, Allocator > 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.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-awesome.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">EnTT<span id="projectnumber"> 3.15.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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">
|
|
<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 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_1basic__scheduler.html">basic_scheduler</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classentt_1_1basic__scheduler-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">entt::basic_scheduler< Delta, Allocator > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Cooperative scheduler for processes.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a232bb21739cbd8084ec723bcc17d44e9" id="r_a232bb21739cbd8084ec723bcc17d44e9"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a232bb21739cbd8084ec723bcc17d44e9">allocator_type</a> = Allocator</td></tr>
|
|
<tr class="memdesc:a232bb21739cbd8084ec723bcc17d44e9"><td class="mdescLeft"> </td><td class="mdescRight">Allocator type. <br /></td></tr>
|
|
<tr class="separator:a232bb21739cbd8084ec723bcc17d44e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65ce482b6daa9eb3117075b7d4eaecc7" id="r_a65ce482b6daa9eb3117075b7d4eaecc7"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a65ce482b6daa9eb3117075b7d4eaecc7">size_type</a> = std::size_t</td></tr>
|
|
<tr class="memdesc:a65ce482b6daa9eb3117075b7d4eaecc7"><td class="mdescLeft"> </td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
|
|
<tr class="separator:a65ce482b6daa9eb3117075b7d4eaecc7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee11899e97bc57ebc9216a1f0f24e329" id="r_aee11899e97bc57ebc9216a1f0f24e329"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#aee11899e97bc57ebc9216a1f0f24e329">delta_type</a> = Delta</td></tr>
|
|
<tr class="memdesc:aee11899e97bc57ebc9216a1f0f24e329"><td class="mdescLeft"> </td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
|
|
<tr class="separator:aee11899e97bc57ebc9216a1f0f24e329"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a3c15133d781d3d2671ff64d4281d8d62" id="r_a3c15133d781d3d2671ff64d4281d8d62"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c15133d781d3d2671ff64d4281d8d62">basic_scheduler</a> ()</td></tr>
|
|
<tr class="memdesc:a3c15133d781d3d2671ff64d4281d8d62"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a3c15133d781d3d2671ff64d4281d8d62"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a730077cba34cf06999080b542e940a2e" id="r_a730077cba34cf06999080b542e940a2e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a730077cba34cf06999080b542e940a2e">basic_scheduler</a> (const <a class="el" href="#a232bb21739cbd8084ec723bcc17d44e9">allocator_type</a> &allocator)</td></tr>
|
|
<tr class="memdesc:a730077cba34cf06999080b542e940a2e"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a scheduler with a given allocator. <br /></td></tr>
|
|
<tr class="separator:a730077cba34cf06999080b542e940a2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0bebce4f1b2c70862171a2a0785ef74c" id="r_a0bebce4f1b2c70862171a2a0785ef74c"><td class="memItemLeft" align="right" valign="top"><a id="a0bebce4f1b2c70862171a2a0785ef74c" name="a0bebce4f1b2c70862171a2a0785ef74c"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>basic_scheduler</b> (const <a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a0bebce4f1b2c70862171a2a0785ef74c"><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor, deleted on purpose. <br /></td></tr>
|
|
<tr class="separator:a0bebce4f1b2c70862171a2a0785ef74c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c3323d871e3654e61afb80a4f05a3da" id="r_a4c3323d871e3654e61afb80a4f05a3da"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4c3323d871e3654e61afb80a4f05a3da">basic_scheduler</a> (<a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> &&other) noexcept</td></tr>
|
|
<tr class="memdesc:a4c3323d871e3654e61afb80a4f05a3da"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:a4c3323d871e3654e61afb80a4f05a3da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab39ad210a5b331208057c7894510c2b0" id="r_ab39ad210a5b331208057c7894510c2b0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab39ad210a5b331208057c7894510c2b0">basic_scheduler</a> (<a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> &&other, const <a class="el" href="#a232bb21739cbd8084ec723bcc17d44e9">allocator_type</a> &allocator)</td></tr>
|
|
<tr class="memdesc:ab39ad210a5b331208057c7894510c2b0"><td class="mdescLeft"> </td><td class="mdescRight">Allocator-extended move constructor. <br /></td></tr>
|
|
<tr class="separator:ab39ad210a5b331208057c7894510c2b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a5de33957c30564f3f7e42c15b7305f" id="r_a7a5de33957c30564f3f7e42c15b7305f"><td class="memItemLeft" align="right" valign="top"><a id="a7a5de33957c30564f3f7e42c15b7305f" name="a7a5de33957c30564f3f7e42c15b7305f"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>~basic_scheduler</b> ()=default</td></tr>
|
|
<tr class="memdesc:a7a5de33957c30564f3f7e42c15b7305f"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a7a5de33957c30564f3f7e42c15b7305f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a466f28758a275cd736b5cbab7b6b1fbb" id="r_a466f28758a275cd736b5cbab7b6b1fbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a466f28758a275cd736b5cbab7b6b1fbb">operator=</a> (const <a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a466f28758a275cd736b5cbab7b6b1fbb"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator, deleted on purpose. <br /></td></tr>
|
|
<tr class="separator:a466f28758a275cd736b5cbab7b6b1fbb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cc74ea04a1e79e23cb8b007cf89b6d6" id="r_a7cc74ea04a1e79e23cb8b007cf89b6d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7cc74ea04a1e79e23cb8b007cf89b6d6">operator=</a> (<a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> &&other) noexcept</td></tr>
|
|
<tr class="memdesc:a7cc74ea04a1e79e23cb8b007cf89b6d6"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <br /></td></tr>
|
|
<tr class="separator:a7cc74ea04a1e79e23cb8b007cf89b6d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2d27cb8fda69dac03d011c66276daa7" id="r_ac2d27cb8fda69dac03d011c66276daa7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac2d27cb8fda69dac03d011c66276daa7">swap</a> (<a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> &other) noexcept</td></tr>
|
|
<tr class="memdesc:ac2d27cb8fda69dac03d011c66276daa7"><td class="mdescLeft"> </td><td class="mdescRight">Exchanges the contents with those of a given scheduler. <br /></td></tr>
|
|
<tr class="separator:ac2d27cb8fda69dac03d011c66276daa7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc471579324ff48d2c55a520024449d3" id="r_abc471579324ff48d2c55a520024449d3"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="#a232bb21739cbd8084ec723bcc17d44e9">allocator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abc471579324ff48d2c55a520024449d3">get_allocator</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:abc471579324ff48d2c55a520024449d3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the associated allocator. <br /></td></tr>
|
|
<tr class="separator:abc471579324ff48d2c55a520024449d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a438e626f597bee890ab71d2d6d2c589f" id="r_a438e626f597bee890ab71d2d6d2c589f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a65ce482b6daa9eb3117075b7d4eaecc7">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a438e626f597bee890ab71d2d6d2c589f">size</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a438e626f597bee890ab71d2d6d2c589f"><td class="mdescLeft"> </td><td class="mdescRight">Number of processes currently scheduled. <br /></td></tr>
|
|
<tr class="separator:a438e626f597bee890ab71d2d6d2c589f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0148252d629fa78ebfe688519013c9c4" id="r_a0148252d629fa78ebfe688519013c9c4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0148252d629fa78ebfe688519013c9c4">empty</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a0148252d629fa78ebfe688519013c9c4"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if at least a process is currently scheduled. <br /></td></tr>
|
|
<tr class="separator:a0148252d629fa78ebfe688519013c9c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae92f6e2916a21e4225bb93cc747a90af" id="r_ae92f6e2916a21e4225bb93cc747a90af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae92f6e2916a21e4225bb93cc747a90af">clear</a> ()</td></tr>
|
|
<tr class="memdesc:ae92f6e2916a21e4225bb93cc747a90af"><td class="mdescLeft"> </td><td class="mdescRight">Discards all scheduled processes. <br /></td></tr>
|
|
<tr class="separator:ae92f6e2916a21e4225bb93cc747a90af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdde3b5231b2c45739f94b1a4206bce8" id="r_afdde3b5231b2c45739f94b1a4206bce8"><td class="memTemplParams" colspan="2">template<typename Proc, typename... Args> </td></tr>
|
|
<tr class="memitem:afdde3b5231b2c45739f94b1a4206bce8"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#afdde3b5231b2c45739f94b1a4206bce8">attach</a> (Args &&...args)</td></tr>
|
|
<tr class="memdesc:afdde3b5231b2c45739f94b1a4206bce8"><td class="mdescLeft"> </td><td class="mdescRight">Schedules a process for the next tick. <br /></td></tr>
|
|
<tr class="separator:afdde3b5231b2c45739f94b1a4206bce8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd7825b29cbc18edb14f5bd32c9b1d97" id="r_abd7825b29cbc18edb14f5bd32c9b1d97"><td class="memTemplParams" colspan="2">template<typename Func> </td></tr>
|
|
<tr class="memitem:abd7825b29cbc18edb14f5bd32c9b1d97"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#abd7825b29cbc18edb14f5bd32c9b1d97">attach</a> (Func &&func)</td></tr>
|
|
<tr class="memdesc:abd7825b29cbc18edb14f5bd32c9b1d97"><td class="mdescLeft"> </td><td class="mdescRight">Schedules a process for the next tick. <br /></td></tr>
|
|
<tr class="separator:abd7825b29cbc18edb14f5bd32c9b1d97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97b6902501430cb4cce602d848d46b7e" id="r_a97b6902501430cb4cce602d848d46b7e"><td class="memTemplParams" colspan="2">template<typename Proc, typename... Args> </td></tr>
|
|
<tr class="memitem:a97b6902501430cb4cce602d848d46b7e"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a97b6902501430cb4cce602d848d46b7e">then</a> (Args &&...args)</td></tr>
|
|
<tr class="memdesc:a97b6902501430cb4cce602d848d46b7e"><td class="mdescLeft"> </td><td class="mdescRight">Sets a process as a continuation of the last scheduled process. <br /></td></tr>
|
|
<tr class="separator:a97b6902501430cb4cce602d848d46b7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4edd1d1540d7d2a5307a646c1c0d880b" id="r_a4edd1d1540d7d2a5307a646c1c0d880b"><td class="memTemplParams" colspan="2">template<typename Func> </td></tr>
|
|
<tr class="memitem:a4edd1d1540d7d2a5307a646c1c0d880b"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a4edd1d1540d7d2a5307a646c1c0d880b">then</a> (Func &&func)</td></tr>
|
|
<tr class="memdesc:a4edd1d1540d7d2a5307a646c1c0d880b"><td class="mdescLeft"> </td><td class="mdescRight">Sets a process as a continuation of the last scheduled process. <br /></td></tr>
|
|
<tr class="separator:a4edd1d1540d7d2a5307a646c1c0d880b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac8d0d131f7e1214c4191048762ccd09" id="r_aac8d0d131f7e1214c4191048762ccd09"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aac8d0d131f7e1214c4191048762ccd09">update</a> (const <a class="el" href="#aee11899e97bc57ebc9216a1f0f24e329">delta_type</a> delta, void *data=nullptr)</td></tr>
|
|
<tr class="memdesc:aac8d0d131f7e1214c4191048762ccd09"><td class="mdescLeft"> </td><td class="mdescRight">Updates all scheduled processes. <br /></td></tr>
|
|
<tr class="separator:aac8d0d131f7e1214c4191048762ccd09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4995b2a91865c59e909057bfb010505" id="r_ab4995b2a91865c59e909057bfb010505"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4995b2a91865c59e909057bfb010505">abort</a> (const bool immediate=false)</td></tr>
|
|
<tr class="memdesc:ab4995b2a91865c59e909057bfb010505"><td class="mdescLeft"> </td><td class="mdescRight">Aborts all scheduled processes. <br /></td></tr>
|
|
<tr class="separator:ab4995b2a91865c59e909057bfb010505"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename Delta, typename Allocator><br />
|
|
class entt::basic_scheduler< Delta, Allocator ></div><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"><a class="code hl_typedef" href="namespaceentt.html#afb4634a5b738455e0b6d35bb5444dbf4">scheduler</a>.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">}).<a class="code hl_function" href="#a97b6902501430cb4cce602d848d46b7e">then<my_process></a>(arguments...);</div>
|
|
<div class="ttc" id="aclassentt_1_1basic__scheduler_html_a97b6902501430cb4cce602d848d46b7e"><div class="ttname"><a href="#a97b6902501430cb4cce602d848d46b7e">entt::basic_scheduler::then</a></div><div class="ttdeci">basic_scheduler & then(Args &&...args)</div><div class="ttdoc">Sets a process as a continuation of the last scheduled process.</div><div class="ttdef"><b>Definition</b> <a href="scheduler_8hpp_source.html#l00294">scheduler.hpp:294</a></div></div>
|
|
<div class="ttc" id="anamespaceentt_html_afb4634a5b738455e0b6d35bb5444dbf4"><div class="ttname"><a href="namespaceentt.html#afb4634a5b738455e0b6d35bb5444dbf4">entt::scheduler</a></div><div class="ttdeci">basic_scheduler<> scheduler</div><div class="ttdoc">Alias declaration for the most common use case.</div><div class="ttdef"><b>Definition</b> <a href="process_2fwd_8hpp_source.html#l00016">fwd.hpp:16</a></div></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>
|
|
<tr><td class="paramname">Allocator</td><td>Type of allocator used to manage memory and elements. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00082">82</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a232bb21739cbd8084ec723bcc17d44e9" name="a232bb21739cbd8084ec723bcc17d44e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a232bb21739cbd8084ec723bcc17d44e9">◆ </a></span>allocator_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::allocator_type = Allocator</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocator type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00095">95</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee11899e97bc57ebc9216a1f0f24e329" name="aee11899e97bc57ebc9216a1f0f24e329"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee11899e97bc57ebc9216a1f0f24e329">◆ </a></span>delta_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::delta_type = Delta</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unsigned integer type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00099">99</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a65ce482b6daa9eb3117075b7d4eaecc7" name="a65ce482b6daa9eb3117075b7d4eaecc7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a65ce482b6daa9eb3117075b7d4eaecc7">◆ </a></span>size_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::size_type = std::size_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unsigned integer type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00097">97</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a3c15133d781d3d2671ff64d4281d8d62" name="a3c15133d781d3d2671ff64d4281d8d62"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c15133d781d3d2671ff64d4281d8d62">◆ </a></span>basic_scheduler() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::basic_scheduler </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00102">102</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a730077cba34cf06999080b542e940a2e" name="a730077cba34cf06999080b542e940a2e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a730077cba34cf06999080b542e940a2e">◆ </a></span>basic_scheduler() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::basic_scheduler </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#a232bb21739cbd8084ec723bcc17d44e9">allocator_type</a> &</td> <td class="paramname"><span class="paramname"><em>allocator</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 explicit">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs a scheduler with a given allocator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">allocator</td><td>The allocator to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00109">109</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c3323d871e3654e61afb80a4f05a3da" name="a4c3323d871e3654e61afb80a4f05a3da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c3323d871e3654e61afb80a4f05a3da">◆ </a></span>basic_scheduler() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::basic_scheduler </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a>< Delta, Allocator > &&</td> <td class="paramname"><span class="paramname"><em>other</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 noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to move from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00119">119</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab39ad210a5b331208057c7894510c2b0" name="ab39ad210a5b331208057c7894510c2b0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab39ad210a5b331208057c7894510c2b0">◆ </a></span>basic_scheduler() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::basic_scheduler </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a>< Delta, Allocator > &&</td> <td class="paramname"><span class="paramname"><em>other</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="#a232bb21739cbd8084ec723bcc17d44e9">allocator_type</a> &</td> <td class="paramname"><span class="paramname"><em>allocator</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocator-extended move constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to move from. </td></tr>
|
|
<tr><td class="paramname">allocator</td><td>The allocator to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00127">127</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ab4995b2a91865c59e909057bfb010505" name="ab4995b2a91865c59e909057bfb010505"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4995b2a91865c59e909057bfb010505">◆ </a></span>abort()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::abort </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool</td> <td class="paramname"><span class="paramname"><em>immediate</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">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">immediate</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#l00352">352</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afdde3b5231b2c45739f94b1a4206bce8" name="afdde3b5231b2c45739f94b1a4206bce8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afdde3b5231b2c45739f94b1a4206bce8">◆ </a></span>attach() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Proc, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::attach </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Schedules a process for the next tick. </p>
|
|
<p>Returned value can be used to attach a continuation for the last process. The continutation is scheduled automatically 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"><a class="code hl_typedef" href="namespaceentt.html#afb4634a5b738455e0b6d35bb5444dbf4">scheduler</a>.attach<my_process>(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">.<a class="code hl_function" href="#a97b6902501430cb4cce602d848d46b7e">then<my_other_process></a>();</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>This process scheduler. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00221">221</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd7825b29cbc18edb14f5bd32c9b1d97" name="abd7825b29cbc18edb14f5bd32c9b1d97"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd7825b29cbc18edb14f5bd32c9b1d97">◆ </a></span>attach() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Func> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::attach </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Func &&</td> <td class="paramname"><span class="paramname"><em>func</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">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="keywordtype">void</span> *data, <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>data</code> is an opaque pointer to user data if any, <code>nullptr</code> otherwise.</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 can be used to attach a continuation for the last process. The continutation is scheduled automatically 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"><a class="code hl_typedef" href="namespaceentt.html#afb4634a5b738455e0b6d35bb5444dbf4">scheduler</a>.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">.<a class="code hl_function" href="#a97b6902501430cb4cce602d848d46b7e">then</a>([](<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">.<a class="code hl_function" href="#a97b6902501430cb4cce602d848d46b7e">then<my_process></a>(arguments...);</div>
|
|
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="structentt_1_1process__adaptor.html" title="Adaptor for lambdas and functors to turn them into processes.">process_adaptor</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>This process scheduler. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00281">281</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae92f6e2916a21e4225bb93cc747a90af" name="ae92f6e2916a21e4225bb93cc747a90af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae92f6e2916a21e4225bb93cc747a90af">◆ </a></span>clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::clear </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> </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#l00191">191</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0148252d629fa78ebfe688519013c9c4" name="a0148252d629fa78ebfe688519013c9c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0148252d629fa78ebfe688519013c9c4">◆ </a></span>empty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::empty </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</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#l00181">181</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc471579324ff48d2c55a520024449d3" name="abc471579324ff48d2c55a520024449d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc471579324ff48d2c55a520024449d3">◆ </a></span>get_allocator()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a232bb21739cbd8084ec723bcc17d44e9">allocator_type</a> <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::get_allocator </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel constexpr">constexpr</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the associated allocator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The associated allocator. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00165">165</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7cc74ea04a1e79e23cb8b007cf89b6d6" name="a7cc74ea04a1e79e23cb8b007cf89b6d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7cc74ea04a1e79e23cb8b007cf89b6d6">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a>< Delta, Allocator > &&</td> <td class="paramname"><span class="paramname"><em>other</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 noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move assignment operator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to move from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>This process scheduler. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00146">146</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a466f28758a275cd736b5cbab7b6b1fbb" name="a466f28758a275cd736b5cbab7b6b1fbb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a466f28758a275cd736b5cbab7b6b1fbb">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a>< Delta, Allocator > &</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 delete">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default copy assignment operator, deleted on purpose. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This process scheduler. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a438e626f597bee890ab71d2d6d2c589f" name="a438e626f597bee890ab71d2d6d2c589f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a438e626f597bee890ab71d2d6d2c589f">◆ </a></span>size()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a65ce482b6daa9eb3117075b7d4eaecc7">size_type</a> <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::size </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</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#l00173">173</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac2d27cb8fda69dac03d011c66276daa7" name="ac2d27cb8fda69dac03d011c66276daa7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2d27cb8fda69dac03d011c66276daa7">◆ </a></span>swap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::swap </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a>< Delta, Allocator > &</td> <td class="paramname"><span class="paramname"><em>other</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 noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Exchanges the contents with those of a given scheduler. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>Scheduler to exchange the content with. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00156">156</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97b6902501430cb4cce602d848d46b7e" name="a97b6902501430cb4cce602d848d46b7e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97b6902501430cb4cce602d848d46b7e">◆ </a></span>then() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Proc, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::then </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets a process as a continuation of the last scheduled process. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Proc</td><td>Type of process to use as a continuation. </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>This process scheduler. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00294">294</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4edd1d1540d7d2a5307a646c1c0d880b" name="a4edd1d1540d7d2a5307a646c1c0d880b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4edd1d1540d7d2a5307a646c1c0d880b">◆ </a></span>then() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Func> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__scheduler.html">basic_scheduler</a> & <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::then </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Func &&</td> <td class="paramname"><span class="paramname"><em>func</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets a process as a continuation of the last scheduled process. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Func</td><td>Type of process to use as a continuation. </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>This process scheduler. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="scheduler_8hpp_source.html#l00310">310</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac8d0d131f7e1214c4191048762ccd09" name="aac8d0d131f7e1214c4191048762ccd09"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac8d0d131f7e1214c4191048762ccd09">◆ </a></span>update()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Delta, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__scheduler.html">entt::basic_scheduler</a>< Delta, Allocator >::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#aee11899e97bc57ebc9216a1f0f24e329">delta_type</a></td> <td class="paramname"><span class="paramname"><em>delta</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">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#l00326">326</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 files:<ul>
|
|
<li>src/entt/process/<a class="el" href="process_2fwd_8hpp_source.html">fwd.hpp</a></li>
|
|
<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 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|