ethread/namespaceethread.html

453 lines
22 KiB
HTML

<!-- HTML header for doxygen 1.8.8-->
<!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="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>ethread: Ewol thread platform tools: ethread Namespace Reference</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<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" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">ethread: Ewol thread platform tools 0.2.0</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">Main&nbsp;Page</a></li>
<li><a href="pages.html">Related&nbsp;Pages</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
Link-libs<span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
<li><a href="http://atria-soft.github.io/echrono">echrono</a></li>
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
<li><a href="http://atria-soft.github.io/etranslate">etranslate</a></li>
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
<li><a href="http://musicdsp.github.io/audio-ess">audio-ess</a></li>
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
</ul>
</li>
</ul>
<div id="search-box" class="input-group">
<div class="input-group-btn">
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
<span class="glyphicon glyphicon-search"></span>
<span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a href="#">All</a></li>
<li><a href="#">Classes</a></li>
<li><a href="#">Namespaces</a></li>
<li><a href="#">Files</a></li>
<li><a href="#">Functions</a></li>
<li><a href="#">Variables</a></li>
<li><a href="#">Typedefs</a></li>
<li><a href="#">Enumerations</a></li>
<li><a href="#">Enumerator</a></li>
<li><a href="#">Friends</a></li>
<li><a href="#">Macros</a></li>
<li><a href="#">Pages</a></li>
</ul>
</div>
<button id="search-close" type="button" class="close" aria-label="Close">
<span aria-hidden="true"></span>
</button>
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
</div>
</div><!--/.nav-collapse -->
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;margin-top: 60px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<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>
<!-- 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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ethread Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a83f5a8674b36a67b3da51220db7644b5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#a83f5a8674b36a67b3da51220db7644b5">getId</a> ()</td></tr>
<tr class="separator:a83f5a8674b36a67b3da51220db7644b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affe719b7f5eadab4bcffe21b2007ea71"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#affe719b7f5eadab4bcffe21b2007ea71">getId</a> (std::thread &amp;_thread)</td></tr>
<tr class="separator:affe719b7f5eadab4bcffe21b2007ea71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae488254d80e02e42e9d1037b4dad4402"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#ae488254d80e02e42e9d1037b4dad4402">setName</a> (const std::string &amp;_name)</td></tr>
<tr class="separator:ae488254d80e02e42e9d1037b4dad4402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addb1c59cb6c882954ff6d9ea42609ded"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#addb1c59cb6c882954ff6d9ea42609ded">setName</a> (std::thread &amp;_thread, const std::string &amp;_name)</td></tr>
<tr class="separator:addb1c59cb6c882954ff6d9ea42609ded"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9ea1bd845bc874b9ccb06756a777d24"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#ac9ea1bd845bc874b9ccb06756a777d24">getName</a> ()</td></tr>
<tr class="separator:ac9ea1bd845bc874b9ccb06756a777d24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7df98043536b77d409b5dac768d2c5e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#ab7df98043536b77d409b5dac768d2c5e">getName</a> (std::thread &amp;_thread)</td></tr>
<tr class="separator:ab7df98043536b77d409b5dac768d2c5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7a8f00de6b5a587f92c66560dc03a53"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#ad7a8f00de6b5a587f92c66560dc03a53">setPriority</a> (int32_t _priority)</td></tr>
<tr class="separator:ad7a8f00de6b5a587f92c66560dc03a53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5007cbb21d80206daa968454f5f4fc74"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#a5007cbb21d80206daa968454f5f4fc74">setPriority</a> (std::thread &amp;_thread, int32_t _priority)</td></tr>
<tr class="separator:a5007cbb21d80206daa968454f5f4fc74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adff3663b66fed843a570b9b293b38c2f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#adff3663b66fed843a570b9b293b38c2f">getPriority</a> ()</td></tr>
<tr class="separator:adff3663b66fed843a570b9b293b38c2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23a50139a66c00365fa563fb6493a42"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceethread.html#ac23a50139a66c00365fa563fb6493a42">getPriority</a> (std::thread &amp;_thread)</td></tr>
<tr class="separator:ac23a50139a66c00365fa563fb6493a42"><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>ethread main namespace </p>
<dl class="section author"><dt>Author</dt><dd>Edouard DUPIN</dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>2011, Edouard DUPIN, all right reserved</dd></dl>
<dl class="section note"><dt>Note</dt><dd>License: APACHE v2.0 (see license file) </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a83f5a8674b36a67b3da51220db7644b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83f5a8674b36a67b3da51220db7644b5">&sect;&nbsp;</a></span>getId() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ethread::getId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get human readable thread ID. (not the std::thread::get_id()) </p>
<dl class="section return"><dt>Returns</dt><dd>the ID of the thread. </dd></dl>
</div>
</div>
<a id="affe719b7f5eadab4bcffe21b2007ea71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affe719b7f5eadab4bcffe21b2007ea71">&sect;&nbsp;</a></span>getId() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ethread::getId </td>
<td>(</td>
<td class="paramtype">std::thread &amp;&#160;</td>
<td class="paramname"><em>_thread</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get human readable thread ID. (not the std::thread::get_id()) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_thread</td><td>Thread handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the ID of the thread. </dd></dl>
</div>
</div>
<a id="ac9ea1bd845bc874b9ccb06756a777d24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9ea1bd845bc874b9ccb06756a777d24">&sect;&nbsp;</a></span>getName() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string ethread::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the Current thread name. </p>
<dl class="section return"><dt>Returns</dt><dd>The current name of the thread </dd></dl>
</div>
</div>
<a id="ab7df98043536b77d409b5dac768d2c5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7df98043536b77d409b5dac768d2c5e">&sect;&nbsp;</a></span>getName() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string ethread::getName </td>
<td>(</td>
<td class="paramtype">std::thread &amp;&#160;</td>
<td class="paramname"><em>_thread</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an other thread name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_thread</td><td>Thread handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The external thread name of the thread </dd></dl>
</div>
</div>
<a id="adff3663b66fed843a570b9b293b38c2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adff3663b66fed843a570b9b293b38c2f">&sect;&nbsp;</a></span>getPriority() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ethread::getPriority </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get the Current thread priority [-20..0] for RT and ]0..50] for normal priority </p>
<dl class="section return"><dt>Returns</dt><dd>current priority of the thread </dd></dl>
</div>
</div>
<a id="ac23a50139a66c00365fa563fb6493a42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac23a50139a66c00365fa563fb6493a42">&sect;&nbsp;</a></span>getPriority() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ethread::getPriority </td>
<td>(</td>
<td class="paramtype">std::thread &amp;&#160;</td>
<td class="paramname"><em>_thread</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an other thread priority [-20..0] for RT and ]0..50] for normal priority. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_thread</td><td>Thread handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current priority of the thread </dd></dl>
</div>
</div>
<a id="ae488254d80e02e42e9d1037b4dad4402"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae488254d80e02e42e9d1037b4dad4402">&sect;&nbsp;</a></span>setName() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ethread::setName </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the Current thread name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_name</td><td>New name of the thread </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="addb1c59cb6c882954ff6d9ea42609ded"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addb1c59cb6c882954ff6d9ea42609ded">&sect;&nbsp;</a></span>setName() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ethread::setName </td>
<td>(</td>
<td class="paramtype">std::thread &amp;&#160;</td>
<td class="paramname"><em>_thread</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set an other thread name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_thread</td><td>Thread handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_name</td><td>New name of the thread </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad7a8f00de6b5a587f92c66560dc03a53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7a8f00de6b5a587f92c66560dc03a53">&sect;&nbsp;</a></span>setPriority() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ethread::setPriority </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>_priority</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the Current thread priority [-20..0] for RT and ]0..50] for normal priority. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_priority</td><td>New priority of the thread </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>If your process have not the right to change thread name, it does not work </dd></dl>
</div>
</div>
<a id="a5007cbb21d80206daa968454f5f4fc74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5007cbb21d80206daa968454f5f4fc74">&sect;&nbsp;</a></span>setPriority() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ethread::setPriority </td>
<td>(</td>
<td class="paramtype">std::thread &amp;&#160;</td>
<td class="paramname"><em>_thread</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>_priority</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set an other thread priority [-20..0] for RT and ]0..50] for normal priority. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_thread</td><td>Thread handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_priority</td><td>New priority of the thread </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>If your process have not the right to change thread name, it does not work </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 24 2016 15:35:51 for ethread: Ewol thread platform tools by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>