Files
entt/process_8md_source.html
2019-08-29 16:16:50 +02:00

75 lines
26 KiB
HTML

<!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: docs/md/process.md Source File</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">3.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle">
<div class="title">docs/md/process.md</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;# Crash Course: cooperative scheduler</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;&lt;!--</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;@cond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;--&gt;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;# Table of Contents</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;* [Introduction](#introduction)</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;* [The process](#the-process)</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; * [Adaptor](#adaptor)</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;* [The scheduler](#the-scheduler)</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;&lt;!--</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;@endcond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;--&gt;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;# Introduction</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;Sometimes processes are a useful tool to work around the strict definition of a</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;system and introduce logic in a different way, usually without resorting to the</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;introduction of other components.</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;`EnTT` offers a minimal support to this paradigm by introducing a few classes</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;that users can use to define and execute cooperative processes.</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;# The process</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;A typical process must inherit from the `process` class template that stays true</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;to the CRTP idiom. Moreover, derived classes must specify what&#39;s the intended</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;type for elapsed times.</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;A process should expose publicly the following member functions whether</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;required (note that it isn&#39;t required to define a function unless the derived</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;class wants to _override_ the default behavior):</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;* `void update(Delta, void *);`</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; It&#39;s invoked once per tick until a process is explicitly aborted or it</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; terminates either with or without errors. Even though it&#39;s not mandatory to</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; declare this member function, as a rule of thumb each process should at</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; least define it to work properly. The `void *` parameter is an opaque pointer</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; to user data (if any) forwarded directly to the process during an update.</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;* `void init();`</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; It&#39;s invoked when the process joins the running queue of a scheduler. This</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; happens as soon as it&#39;s attached to the scheduler if the process is a top</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; level one, otherwise when it replaces its parent if the process is a</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; continuation.</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;* `void succeeded();`</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; It&#39;s invoked in case of success, immediately after an update and during the</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; same tick.</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;* `void failed();`</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; It&#39;s invoked in case of errors, immediately after an update and during the</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; same tick.</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;* `void aborted();`</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; It&#39;s invoked only if a process is explicitly aborted. There is no guarantee</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; that it executes in the same tick, this depends solely on whether the</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; process is aborted immediately or not.</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;Derived classes can also change the internal state of a process by invoking</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;`succeed` and `fail`, as well as `pause` and `unpause` the process itself. All</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;these are protected member functions made available to be able to manage the</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;life cycle of a process from a derived class.</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;Here is a minimal example for the sake of curiosity:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;```cpp</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;struct my_process: entt::process&lt;my_process, std::uint32_t&gt; {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; using delta_type = std::uint32_t;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; void update(delta_type delta, void *) {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; remaining -= std::min(remaining, delta);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; // ...</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; if(!remaining) {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; succeed();</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;private:</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; delta_type remaining{1000u};</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;};</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;```</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;## Adaptor</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;Lambdas and functors can&#39;t be used directly with a scheduler for they are not</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;properly defined processes with managed life cycles.&lt;br/&gt;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;This class helps in filling the gap and turning lambdas and functors into</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;full featured processes usable by a scheduler.</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;The function call operator has a signature similar to the one of the `update`</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;function of a process but for the fact that it receives two extra arguments to</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;call whenever a process is terminated with success or with an error:</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;```cpp</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;void(Delta delta, void *data, auto succeed, auto fail);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;```</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;Parameters have the following meaning:</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;* `delta` is the elapsed time.</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;* `data` is an opaque pointer to user data if any, `nullptr` otherwise.</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;* `succeed` is a function to call when a process terminates with success.</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;* `fail` is a function to call when a process terminates with errors.</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;Both `succeed` and `fail` accept no parameters at all.</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;Note that usually users shouldn&#39;t worry about creating adaptors at all. A</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;scheduler creates them internally each and every time a lambda or a functor is</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;used as a process.</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;# The scheduler</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;A cooperative scheduler runs different processes and helps managing their life</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;cycles.</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;Each process is invoked once per tick. If it terminates, it&#39;s removed</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;automatically from the scheduler and it&#39;s never invoked again. Otherwise it&#39;s</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;a good candidate to run one more time the next tick.&lt;br/&gt;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;A process can also have a child. In this case, the parent process is replaced</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;with its child when it terminates and only if it returns with success. In case</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;of errors, both the parent process and its child are discarded. This way, it&#39;s</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;easy to create chain of processes to run sequentially.</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;Using a scheduler is straightforward. To create it, users must provide only the</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;type for the elapsed times and no arguments at all:</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;```cpp</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;entt::scheduler&lt;std::uint32_t&gt; scheduler;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;```</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;It has member functions to query its internal data structures, like `empty` or</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;`size`, as well as a `clear` utility to reset it to a clean state:</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;```cpp</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;// checks if there are processes still running</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;const auto empty = scheduler.empty();</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;// gets the number of processes still running</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;entt::scheduler&lt;std::uint32_t&gt;::size_type size = scheduler.size();</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;// resets the scheduler to its initial state and discards all the processes</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;scheduler.clear();</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;```</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;To attach a process to a scheduler there are mainly two ways:</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;* If the process inherits from the `process` class template, it&#39;s enough to</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; indicate its type and submit all the parameters required to construct it to</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; the `attach` member function:</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; ```cpp</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; scheduler.attach&lt;my_process&gt;(&quot;foobar&quot;);</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; ```</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;* Otherwise, in case of a lambda or a functor, it&#39;s enough to provide an</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; instance of the class to the `attach` member function:</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; ```cpp</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; scheduler.attach([](auto...){ /* ... */ });</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; ```</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;In both cases, the return value is an opaque object that offers a `then` member</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;function to use to create chains of processes to run sequentially.&lt;br/&gt;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;As a minimal example of use:</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;```cpp</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;// schedules a task in the form of a lambda function</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;scheduler.attach([](auto delta, void *, auto succeed, auto fail) {</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; // ...</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;})</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;// appends a child in the form of another lambda function</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;.then([](auto delta, void *, auto succeed, auto fail) {</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; // ...</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;})</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;// appends a child in the form of a process class</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;.then&lt;my_process&gt;();</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;```</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;To update a scheduler and therefore all its processes, the `update` member</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;function is the way to go:</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;```cpp</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;// updates all the processes, no user data are provided</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;scheduler.update(delta);</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160;</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;// updates all the processes and provides them with custom data</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;scheduler.update(delta, &amp;data);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;```</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;In addition to these functions, the scheduler offers an `abort` member function</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;that can be used to discard all the running processes at once:</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;```cpp</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;// aborts all the processes abruptly ...</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;scheduler.abort(true);</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;// ... or gracefully during the next tick</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;scheduler.abort();</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;```</div></div><!-- fragment --></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>