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: Thread 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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classThread-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Thread Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">
<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:a43ff15a88d142fd3fb112f6f801ad1ef"><td class="memItemLeft" align="right" valign="top"><a id="a43ff15a88d142fd3fb112f6f801ad1ef"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isThreadRunning</b> () const noexcept</td></tr>
<tr class="separator:a43ff15a88d142fd3fb112f6f801ad1ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a261ed6f5073b681129d6892b645aeac9"><td class="memItemLeft" align="right" valign="top"><a id="a261ed6f5073b681129d6892b645aeac9"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>shouldThreadExit</b> () const noexcept</td></tr>
<tr class="separator:a261ed6f5073b681129d6892b645aeac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a054398add0c09bb9134686c40be10590"><td class="memItemLeft" align="right" valign="top"><a id="a054398add0c09bb9134686c40be10590"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>startThread</b> (const bool withRealtimePriority=false) noexcept</td></tr>
<tr class="separator:a054398add0c09bb9134686c40be10590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35a7bf228734d406243d7c52739f5c93"><td class="memItemLeft" align="right" valign="top"><a id="a35a7bf228734d406243d7c52739f5c93"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>stopThread</b> (const int timeOutMilliseconds) noexcept</td></tr>
<tr class="separator:a35a7bf228734d406243d7c52739f5c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72043b3684f6b51a089dff65f523491a"><td class="memItemLeft" align="right" valign="top"><a id="a72043b3684f6b51a089dff65f523491a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>signalThreadShouldExit</b> () noexcept</td></tr>
<tr class="separator:a72043b3684f6b51a089dff65f523491a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04ae21de0884d0814efe13de1ff475be"><td class="memItemLeft" align="right" valign="top"><a id="a04ae21de0884d0814efe13de1ff475be"></a>
const <a class="el" href="classString.html">String</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getThreadName</b> () const noexcept</td></tr>
<tr class="separator:a04ae21de0884d0814efe13de1ff475be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a980c9dcf4c4c2b9e64bf2269fc3623e5"><td class="memItemLeft" align="right" valign="top"><a id="a980c9dcf4c4c2b9e64bf2269fc3623e5"></a>
pthread_t&#160;</td><td class="memItemRight" valign="bottom"><b>getThreadId</b> () const noexcept</td></tr>
<tr class="separator:a980c9dcf4c4c2b9e64bf2269fc3623e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:accc450d8056f287d984c2cd8866daf2f"><td class="memItemLeft" align="right" valign="top"><a id="accc450d8056f287d984c2cd8866daf2f"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>setCurrentThreadName</b> (const char *const name) noexcept</td></tr>
<tr class="separator:accc450d8056f287d984c2cd8866daf2f"><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:a296f51dbefe82aa028d2cfabe1afc6a9"><td class="memItemLeft" align="right" valign="top"><a id="a296f51dbefe82aa028d2cfabe1afc6a9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Thread</b> (const char *const threadName=nullptr) noexcept</td></tr>
<tr class="separator:a296f51dbefe82aa028d2cfabe1afc6a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae90dfabab3e1776cf01a26e7ee3a620"><td class="memItemLeft" align="right" valign="top"><a id="aae90dfabab3e1776cf01a26e7ee3a620"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>run</b> ()=0</td></tr>
<tr class="separator:aae90dfabab3e1776cf01a26e7ee3a620"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>distrho/extra/<a class="el" href="Thread_8hpp_source.html">Thread.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>