DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DISTRHO Plugin Framework: Runner Class 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">DISTRHO Plugin Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classRunner-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Runner Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="Runner_8hpp_source.html">Runner.hpp</a>&gt;</code></p>
<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:a844eabf3ab9930f1cf2aaa9a474296cf"><td class="memItemLeft" align="right" valign="top"><a id="a844eabf3ab9930f1cf2aaa9a474296cf"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isRunnerActive</b> () noexcept</td></tr>
<tr class="separator:a844eabf3ab9930f1cf2aaa9a474296cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0278b1417e8392c8dd8532d577aa750"><td class="memItemLeft" align="right" valign="top"><a id="aa0278b1417e8392c8dd8532d577aa750"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>startRunner</b> (const uint timeIntervalMilliseconds=0) noexcept</td></tr>
<tr class="separator:aa0278b1417e8392c8dd8532d577aa750"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dadc02a6c5ac90fec28c25178246dc2"><td class="memItemLeft" align="right" valign="top"><a id="a3dadc02a6c5ac90fec28c25178246dc2"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>stopRunner</b> () noexcept</td></tr>
<tr class="separator:a3dadc02a6c5ac90fec28c25178246dc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54c2a779936da5e982dc1c37cb61e508"><td class="memItemLeft" align="right" valign="top"><a id="a54c2a779936da5e982dc1c37cb61e508"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>signalRunnerShouldStop</b> () noexcept</td></tr>
<tr class="separator:a54c2a779936da5e982dc1c37cb61e508"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21ba2c66caf806064e932b36468505ab"><td class="memItemLeft" align="right" valign="top"><a id="a21ba2c66caf806064e932b36468505ab"></a>
const <a class="el" href="classString.html">String</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getRunnerName</b> () const noexcept</td></tr>
<tr class="separator:a21ba2c66caf806064e932b36468505ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a99a07b188bfc71b24d7153e89a88b0f0"><td class="memItemLeft" align="right" valign="top"><a id="a99a07b188bfc71b24d7153e89a88b0f0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Runner</b> (const char *const runnerName=nullptr) noexcept</td></tr>
<tr class="separator:a99a07b188bfc71b24d7153e89a88b0f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d5528882cbe38629af296e5f8615a1f"><td class="memItemLeft" align="right" valign="top"><a id="a4d5528882cbe38629af296e5f8615a1f"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>run</b> ()=0</td></tr>
<tr class="separator:a4d5528882cbe38629af296e5f8615a1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42b221763fdfd1e0ef4a681c1552c12c"><td class="memItemLeft" align="right" valign="top"><a id="a42b221763fdfd1e0ef4a681c1552c12c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>shouldRunnerStop</b> () const noexcept</td></tr>
<tr class="separator:a42b221763fdfd1e0ef4a681c1552c12c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classRunner.html">Runner</a> class for DPF.</p>
<p>This is a handy class that handles "idle" time in either background or main thread, whichever is more suitable to the target platform. Typically background threads on desktop platforms, main thread on web.</p>
<p>A single function is expected to be implemented by subclasses, which directly allows it to stop the runner by returning false.</p>
<p>You can use it for quick operations that do not need to be handled in the main thread if possible. The target is to spread out execution over many runs, instead of spending a lot of time on a single task. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>distrho/extra/<a class="el" href="Runner_8hpp_source.html">Runner.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>