luo980/uvw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
gh-pages
uvw/classuvw_1_1Thread.html
Michele Caini 273f6fe65e updated doc: v3.1.0
2023-05-22 11:13:58 +02:00

366 lines
19 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvw: uvw::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 id="projectrow">
<td id="projectalign">
<div id="projectname">uvw<span id="projectnumber">&#160;3.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="classuvw_1_1thread.html">thread</a></li> </ul>
</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="classuvw_1_1thread-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">uvw::thread Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>The thread wrapper.
<a href="classuvw_1_1thread.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="thread_8h_source.html">thread.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for uvw::thread:</div>
<div class="dyncontent">
<div class="center"><img src="classuvw_1_1thread__inherit__graph.png" border="0" usemap="#auvw_1_1thread_inherit__map" alt="Inheritance graph"/></div>
<map name="auvw_1_1thread_inherit__map" id="auvw_1_1thread_inherit__map">
<area shape="rect" title="The thread wrapper." alt="" coords="55,79,141,104"/>
<area shape="rect" href="structuvw_1_1uv__type.html" title=" " alt="" coords="5,5,191,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for uvw::thread:</div>
<div class="dyncontent">
<div class="center"><img src="classuvw_1_1thread__coll__graph.png" border="0" usemap="#auvw_1_1thread_coll__map" alt="Collaboration graph"/></div>
<map name="auvw_1_1thread_coll__map" id="auvw_1_1thread_coll__map">
<area shape="rect" title="The thread wrapper." alt="" coords="55,79,141,104"/>
<area shape="rect" href="structuvw_1_1uv__type.html" title=" " alt="" coords="5,5,191,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aed8c11f06ad88681453bb79e07605049"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1thread.html#aed8c11f06ad88681453bb79e07605049">run</a> () noexcept</td></tr>
<tr class="memdesc:aed8c11f06ad88681453bb79e07605049"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new thread. <br /></td></tr>
<tr class="separator:aed8c11f06ad88681453bb79e07605049"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a662d4100464cb654407ffb4d0d4e7e5f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1thread.html#a662d4100464cb654407ffb4d0d4e7e5f">run</a> (create_flags opts, std::size_t stack={}) noexcept</td></tr>
<tr class="memdesc:a662d4100464cb654407ffb4d0d4e7e5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new thread. <br /></td></tr>
<tr class="separator:a662d4100464cb654407ffb4d0d4e7e5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfc275f0f1776cc8bc94540649099d0f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1thread.html#acfc275f0f1776cc8bc94540649099d0f">join</a> () noexcept</td></tr>
<tr class="memdesc:acfc275f0f1776cc8bc94540649099d0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Joins with a terminated thread. <br /></td></tr>
<tr class="separator:acfc275f0f1776cc8bc94540649099d0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structuvw_1_1uv__type"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structuvw_1_1uv__type')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structuvw_1_1uv__type.html">uvw::uv_type&lt; uv_thread_t &gt;</a></td></tr>
<tr class="memitem:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae97ffacc0b381610d8d18a62a957a69c">init</a> ()</td></tr>
<tr class="memdesc:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the handle. <br /></td></tr>
<tr class="separator:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1loop.html">loop</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae03b0ebbae151c6157c5ba6a24a39a7b">parent</a> () const noexcept</td></tr>
<tr class="memdesc:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the loop from which the resource was originated. <br /></td></tr>
<tr class="separator:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">const uv_thread_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">raw</a> () const noexcept</td></tr>
<tr class="memdesc:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
<tr class="separator:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">uv_thread_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#af4b6f395815f2e99302b5f09be23767c">raw</a> () noexcept</td></tr>
<tr class="memdesc:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
<tr class="separator:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a148dc9a339fe0f610a57dabf17b4f420"><td class="memItemLeft" align="right" valign="top">static type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1thread.html#a148dc9a339fe0f610a57dabf17b4f420">self</a> () noexcept</td></tr>
<tr class="memdesc:a148dc9a339fe0f610a57dabf17b4f420"><td class="mdescLeft">&#160;</td><td class="mdescRight">Obtains the identifier of the calling thread. <br /></td></tr>
<tr class="separator:a148dc9a339fe0f610a57dabf17b4f420"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cf983df5ed1950322e1194a110c1df5"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1thread.html#a9cf983df5ed1950322e1194a110c1df5">getcpu</a> () noexcept</td></tr>
<tr class="memdesc:a9cf983df5ed1950322e1194a110c1df5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the CPU number on which the calling thread is running. <br /></td></tr>
<tr class="separator:a9cf983df5ed1950322e1194a110c1df5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc4cd4285f800475959668bb4f49201d"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1thread.html#abc4cd4285f800475959668bb4f49201d">equal</a> (const <a class="el" href="classuvw_1_1thread.html">thread</a> &amp;tl, const <a class="el" href="classuvw_1_1thread.html">thread</a> &amp;tr) noexcept</td></tr>
<tr class="memdesc:abc4cd4285f800475959668bb4f49201d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares thread by means of their identifiers. <br /></td></tr>
<tr class="separator:abc4cd4285f800475959668bb4f49201d"><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>The thread wrapper. </p>
<p>To create a <code>thread</code> through a <code>loop</code>, arguments follow:</p>
<ul>
<li>A callback invoked to initialize thread execution. The type must be such that it can be assigned to an <code>std::function&lt;void(std::shared_ptr&lt;void&gt;)&gt;</code>.</li>
<li>An optional payload the type of which is <code>std::shared_ptr&lt;void&gt;</code>. </li>
</ul>
<p class="definition">Definition at line <a class="el" href="thread_8h_source.html#l00045">45</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abc4cd4285f800475959668bb4f49201d" name="abc4cd4285f800475959668bb4f49201d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc4cd4285f800475959668bb4f49201d">&#9670;&#160;</a></span>equal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool uvw::thread::equal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classuvw_1_1thread.html">thread</a> &amp;&#160;</td>
<td class="paramname"><em>tl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classuvw_1_1thread.html">thread</a> &amp;&#160;</td>
<td class="paramname"><em>tr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares thread by means of their identifiers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tl</td><td>A valid instance of a thread. </td></tr>
<tr><td class="paramname">tr</td><td>A valid instance of a thread. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the two threads are the same thread, false otherwise. </dd></dl>
</div>
</div>
<a id="a9cf983df5ed1950322e1194a110c1df5" name="a9cf983df5ed1950322e1194a110c1df5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cf983df5ed1950322e1194a110c1df5">&#9670;&#160;</a></span>getcpu()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int uvw::thread::getcpu </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the CPU number on which the calling thread is running. </p>
<dl class="section return"><dt>Returns</dt><dd>The CPU number on which the calling thread is running. </dd></dl>
</div>
</div>
<a id="acfc275f0f1776cc8bc94540649099d0f" name="acfc275f0f1776cc8bc94540649099d0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfc275f0f1776cc8bc94540649099d0f">&#9670;&#160;</a></span>join()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool uvw::thread::join </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Joins with a terminated thread. </p>
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
</div>
</div>
<a id="aed8c11f06ad88681453bb79e07605049" name="aed8c11f06ad88681453bb79e07605049"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed8c11f06ad88681453bb79e07605049">&#9670;&#160;</a></span>run() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool uvw::thread::run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new thread. </p>
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
</div>
</div>
<a id="a662d4100464cb654407ffb4d0d4e7e5f" name="a662d4100464cb654407ffb4d0d4e7e5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a662d4100464cb654407ffb4d0d4e7e5f">&#9670;&#160;</a></span>run() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool uvw::thread::run </td>
<td>(</td>
<td class="paramtype">create_flags&#160;</td>
<td class="paramname"><em>opts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>stack</em> = <code>{}</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new thread. </p>
<p>Available flags are:</p>
<ul>
<li><code>thread::create_flags::THREAD_NO_FLAGS</code>: no flags set.</li>
<li><code>thread::create_flags::THREAD_HAS_STACK_SIZE</code>: if set, <code>stack</code> specifies a stack size for the new thread. 0 indicates that the default value should be used (it behaves as if the flag was not set). Other values will be rounded up to the nearest page boundary.</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
</div>
</div>
<a id="a148dc9a339fe0f610a57dabf17b4f420" name="a148dc9a339fe0f610a57dabf17b4f420"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a148dc9a339fe0f610a57dabf17b4f420">&#9670;&#160;</a></span>self()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static type uvw::thread::self </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtains the identifier of the calling thread. </p>
<dl class="section return"><dt>Returns</dt><dd>The identifier of the calling thread. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/uvw/<a class="el" href="thread_8h_source.html">thread.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.6
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink