mirror of
https://github.com/CDevJoud/Minecraft-Community-Edition.git
synced 2026-07-16 07:40:51 +00:00
207 lines
9.9 KiB
HTML
207 lines
9.9 KiB
HTML
<!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.16.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Minecraft Community Edition: mce::ThreadImpl Class Reference</title>
|
|
<link rel="icon" href="logo channel.png" type="image/x-icon" />
|
|
<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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.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">Minecraft Community Edition<span id="projectnumber"> 0.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.16.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</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',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(function(){initNavTree('classmce_1_1_thread_impl.html','','classmce_1_1_thread_impl-members'); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle"><div class="title">mce::ThreadImpl Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Platform-specific thread implementation.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_thread_impl_8hpp_source.html">ThreadImpl.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a671887ec3998eab1d2f0262a85a3b087" id="r_a671887ec3998eab1d2f0262a85a3b087"><td class="memItemLeft"> </td><td class="memItemRight"><a class="el" href="#a671887ec3998eab1d2f0262a85a3b087">ThreadImpl</a> (<a class="el" href="classmce_1_1_thread.html">Thread</a> *owner)</td></tr>
|
|
<tr class="memdesc:a671887ec3998eab1d2f0262a85a3b087"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classmce_1_1_thread_impl.html" title="Platform-specific thread implementation.">ThreadImpl</a> bound to its owner. <br /></td></tr>
|
|
<tr class="memitem:a2608abc24e2f18be8e25eb3a4265cdda" id="r_a2608abc24e2f18be8e25eb3a4265cdda"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a2608abc24e2f18be8e25eb3a4265cdda">wait</a> ()</td></tr>
|
|
<tr class="memdesc:a2608abc24e2f18be8e25eb3a4265cdda"><td class="mdescLeft"> </td><td class="mdescRight">Block until the associated thread exits. <br /></td></tr>
|
|
<tr class="memitem:ae003bae531fde909b1cb13d6159b1fcb" id="r_ae003bae531fde909b1cb13d6159b1fcb"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#ae003bae531fde909b1cb13d6159b1fcb">terminate</a> ()</td></tr>
|
|
<tr class="memdesc:ae003bae531fde909b1cb13d6159b1fcb"><td class="mdescLeft"> </td><td class="mdescRight">Request termination of the associated thread. <br /></td></tr>
|
|
<tr class="memitem:a04397faafd93d5b2d66912a8ee7ce642" id="r_a04397faafd93d5b2d66912a8ee7ce642"><td class="memItemLeft"><a id="a04397faafd93d5b2d66912a8ee7ce642" name="a04397faafd93d5b2d66912a8ee7ce642"></a>
|
|
bool </td><td class="memItemRight"><b>isRunning</b> () const</td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Platform-specific thread implementation. </p>
|
|
<p>This class encapsulates native thread handles and provides a small interface for the <a class="el" href="classmce_1_1_thread.html" title="Lightweight high-level thread wrapper.">Thread</a> wrapper to control thread lifetime.</p>
|
|
<p>It is intentionally non-copyable (implicitly, due to native handles). </p>
|
|
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a671887ec3998eab1d2f0262a85a3b087" name="a671887ec3998eab1d2f0262a85a3b087"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a671887ec3998eab1d2f0262a85a3b087">◆ </a></span>ThreadImpl()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mce::ThreadImpl::ThreadImpl </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmce_1_1_thread.html">Thread</a> *</td> <td class="paramname"><span class="paramname"><em>owner</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a <a class="el" href="classmce_1_1_thread_impl.html" title="Platform-specific thread implementation.">ThreadImpl</a> bound to its owner. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">owner</td><td>Pointer to the high-level <a class="el" href="classmce_1_1_thread.html" title="Lightweight high-level thread wrapper.">Thread</a> object that owns this implementation.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The owner is stored by reference only for use inside the static entryPoint function to call back into Thread::run() or equivalent. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
|
|
<a id="ae003bae531fde909b1cb13d6159b1fcb" name="ae003bae531fde909b1cb13d6159b1fcb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae003bae531fde909b1cb13d6159b1fcb">◆ </a></span>terminate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mce::ThreadImpl::terminate </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Request termination of the associated thread. </p>
|
|
<p>Implementations may signal the thread to stop or forcibly terminate the native thread handle depending on platform support and usage.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Prefer cooperative shutdown via shared flags when possible. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2608abc24e2f18be8e25eb3a4265cdda" name="a2608abc24e2f18be8e25eb3a4265cdda"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2608abc24e2f18be8e25eb3a4265cdda">◆ </a></span>wait()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mce::ThreadImpl::wait </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Block until the associated thread exits. </p>
|
|
<p>On success this method returns after the remote thread has terminated. Behavior and error handling are platform-specific. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>Core/<a class="el" href="_thread_impl_8hpp_source.html">ThreadImpl.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>mce</b></li><li class="navelem"><a href="classmce_1_1_thread_impl.html">ThreadImpl</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|