arduino/arduino-audio-tools
1
0
Fork 0
mirror of https://github.com/pschatzmann/arduino-audio-tools.git synced 2024-09-21 10:27:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
5eb1ca27a0
arduino-audio-tools/classaudio__tools_1_1_task.html

158 lines
11 KiB
HTML
Raw Normal View History

Deploying to doxygen from @ pschatzmann/arduino-audio-tools@fab4a76d574905d18c897c8285266e9e78b897a7 🚀
2024-07-22 10:51:14 +00:00
<!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>arduino-audio-tools: Task 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">arduino-audio-tools
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceaudio__tools.html">audio_tools</a></li><li class="navelem"><a class="el" href="classaudio__tools_1_1_task.html">Task</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classaudio__tools_1_1_task-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Task Class Reference<div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> &raquo; <a class="el" href="group__concurrency.html">Concurrency</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>FreeRTOS task.
<a href="classaudio__tools_1_1_task.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_task_8h_source.html">Task.h</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:a803e1db59ce7b20ba3f1d0bbe3e57404"><td class="memItemLeft" align="right" valign="top"><a id="a803e1db59ce7b20ba3f1d0bbe3e57404"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_task.html#a803e1db59ce7b20ba3f1d0bbe3e57404">Task</a> (const char *name, int stackSize, int priority=1, int core=-1)</td></tr>
<tr class="memdesc:a803e1db59ce7b20ba3f1d0bbe3e57404"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines and creates a FreeRTOS task. <br /></td></tr>
<tr class="separator:a803e1db59ce7b20ba3f1d0bbe3e57404"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1d9b45dd981a313a51ec91aca72a853"><td class="memItemLeft" align="right" valign="top"><a id="ac1d9b45dd981a313a51ec91aca72a853"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> (std::function&lt; void()&gt; process)</td></tr>
<tr class="separator:ac1d9b45dd981a313a51ec91aca72a853"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0924715b76f5f0305eda62e802cfcf2b"><td class="memItemLeft" align="right" valign="top"><a id="a0924715b76f5f0305eda62e802cfcf2b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_task.html#a0924715b76f5f0305eda62e802cfcf2b">create</a> (const char *name, int stackSize, int priority=1, int core=-1)</td></tr>
<tr class="memdesc:a0924715b76f5f0305eda62e802cfcf2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">If you used the empty constructor, you need to call create! <br /></td></tr>
<tr class="separator:a0924715b76f5f0305eda62e802cfcf2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf81d3fdaf258088d7692fa70cece087"><td class="memItemLeft" align="right" valign="top"><a id="aaf81d3fdaf258088d7692fa70cece087"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_task.html#aaf81d3fdaf258088d7692fa70cece087">end</a> ()</td></tr>
<tr class="memdesc:aaf81d3fdaf258088d7692fa70cece087"><td class="mdescLeft">&#160;</td><td class="mdescRight">suspends the task <br /></td></tr>
<tr class="separator:aaf81d3fdaf258088d7692fa70cece087"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77e448ed32d70ca898f5c8f5919aa074"><td class="memItemLeft" align="right" valign="top"><a id="a77e448ed32d70ca898f5c8f5919aa074"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getCoreID</b> ()</td></tr>
<tr class="separator:a77e448ed32d70ca898f5c8f5919aa074"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d884b24e7706e72a8ad57f37c259744"><td class="memItemLeft" align="right" valign="top"><a id="a1d884b24e7706e72a8ad57f37c259744"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>getReference</b> ()</td></tr>
<tr class="separator:a1d884b24e7706e72a8ad57f37c259744"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52eac11d02842356748fd58595af2d4a"><td class="memItemLeft" align="right" valign="top"><a id="a52eac11d02842356748fd58595af2d4a"></a>
TaskHandle_t &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getTaskHandle</b> ()</td></tr>
<tr class="separator:a52eac11d02842356748fd58595af2d4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fcb45e5d2428352eb36b487d1d4eea3"><td class="memItemLeft" align="right" valign="top"><a id="a1fcb45e5d2428352eb36b487d1d4eea3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_task.html#a1fcb45e5d2428352eb36b487d1d4eea3">remove</a> ()</td></tr>
<tr class="memdesc:a1fcb45e5d2428352eb36b487d1d4eea3"><td class="mdescLeft">&#160;</td><td class="mdescRight">deletes the FreeRTOS task <br /></td></tr>
<tr class="separator:a1fcb45e5d2428352eb36b487d1d4eea3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41de8150eff044a237990c271d57ea27"><td class="memItemLeft" align="right" valign="top"><a id="a41de8150eff044a237990c271d57ea27"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>resume</b> ()</td></tr>
<tr class="separator:a41de8150eff044a237990c271d57ea27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada1836422e5c1d2e0fc25b6c483348bf"><td class="memItemLeft" align="right" valign="top"><a id="ada1836422e5c1d2e0fc25b6c483348bf"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setReference</b> (void *r)</td></tr>
<tr class="separator:ada1836422e5c1d2e0fc25b6c483348bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3605b58fb45d69d498721bc2f2a14b1c"><td class="memItemLeft" align="right" valign="top"><a id="a3605b58fb45d69d498721bc2f2a14b1c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>suspend</b> ()</td></tr>
<tr class="separator:a3605b58fb45d69d498721bc2f2a14b1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a6d85d4307810ddbf4ea8595d782e3498"><td class="memItemLeft" align="right" valign="top"><a id="a6d85d4307810ddbf4ea8595d782e3498"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>nop</b> ()</td></tr>
<tr class="separator:a6d85d4307810ddbf4ea8595d782e3498"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6b8ded6c8a1f59e793981943964bcaa"><td class="memItemLeft" align="right" valign="top"><a id="aa6b8ded6c8a1f59e793981943964bcaa"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>task_loop</b> (void *arg)</td></tr>
<tr class="separator:aa6b8ded6c8a1f59e793981943964bcaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ab153441a2052f80aafe00768ea80aee0"><td class="memItemLeft" align="right" valign="top"><a id="ab153441a2052f80aafe00768ea80aee0"></a>
std::function&lt; void()&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>loop_code</b> = nop</td></tr>
<tr class="separator:ab153441a2052f80aafe00768ea80aee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1830ddb36c14bdd7057683e633f918c8"><td class="memItemLeft" align="right" valign="top"><a id="a1830ddb36c14bdd7057683e633f918c8"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>ref</b></td></tr>
<tr class="separator:a1830ddb36c14bdd7057683e633f918c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01ba122aba7d048809e2330ee6cbe218"><td class="memItemLeft" align="right" valign="top"><a id="a01ba122aba7d048809e2330ee6cbe218"></a>
TaskHandle_t&#160;</td><td class="memItemRight" valign="bottom"><b>xHandle</b> = nullptr</td></tr>
<tr class="separator:a01ba122aba7d048809e2330ee6cbe218"><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>FreeRTOS task. </p>
<dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>GPLv3 * </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Concurrency/<a class="el" href="_task_8h_source.html">Task.h</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>
Reference in New Issue Copy Permalink