282 lines
21 KiB
HTML
282 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="zh" dir="ltr" class="client-nojs" xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh">
|
|
<head><meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>标准库头文件 <thread></title>
|
|
<link rel="stylesheet" href="ext.css" />
|
|
<link rel="stylesheet" href="site_modules.css" />
|
|
</head>
|
|
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-cpp_header_thread skin-cppreference2 action-view cpp-navbar">
|
|
<div id="cpp-content-base">
|
|
<div id="content"><a id="top"></a>
|
|
<h1 id="firstHeading" class="firstHeading"><span style="font-size:0.7em; line-height:130%">标准库头文件</span> <thread></h1>
|
|
<div id="bodyContent">
|
|
<div id="contentSub"><span class="subpages">< <a href="cpp.html">cpp</a>‎ | <a href="cpp-header.html">header</a></span></div>
|
|
<div id="mw-content-text" lang="zh" dir="ltr" class="mw-content-ltr" xml:lang="zh">
|
|
<p>此头文件是<a href="cpp-thread.html">线程支持</a>库的一部分。</p>
|
|
<table class="t-dsc-begin">
|
|
<tr>
|
|
<td colspan="2">
|
|
<h3><span class="mw-headline" id=".E5.8C.85.E5.90.AB">包含</span></h3>
|
|
</td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-header-compare.html"><span class="t-lines"><span><compare></span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td><a href="cpp-language-operator_comparison.html#.E4.B8.89.E8.B7.AF.E6.AF.94.E8.BE.83">三路比较运算符</a>支持</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<h3><span class="mw-headline" id=".E5.91.BD.E5.90.8D.E7.A9.BA.E9.97.B4">命名空间</span></h3>
|
|
</td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td><code><b>this_thread</b></code></td>
|
|
<td>提供访问当前执行线程的函数</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<h3><span class="mw-headline" id=".E7.B1.BB">类</span></h3>
|
|
</td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-thread.html"><span class="t-lines"><span>thread</span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>管理单独的线程<br />
|
|
<span class="t-mark">(类)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-jthread.html"><span class="t-lines"><span>jthread</span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>有自动合并和取消支持的 <span class="t-lc"><a href="cpp-thread-thread.html">std::thread</a></span><br />
|
|
<span class="t-mark">(类)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-thread-id-hash.html"><span class="t-lines"><span>std::hash<span class="t-dsc-small"><std::thread::id></span></span></span></a></div>
|
|
</div>
|
|
</td>
|
|
<td>特化 <span class="t-lc"><a href="cpp-utility-hash.html">std::hash</a></span><br />
|
|
<span class="t-mark">(类模板特化)</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<h3><span class="mw-headline" id=".E5.87.BD.E6.95.B0">函数</span></h3>
|
|
</td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-thread-swap2.html"><span class="t-lines"><span>std::swap<span class="t-dsc-small">(std::thread)</span></span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>特化 <span class="t-lc"><a href="cpp-algorithm-swap.html">std::swap</a></span> 算法<br />
|
|
<span class="t-mark">(函数)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-thread-id-operator_cmp.html"><span class="t-lines"><span>operator==</span><span>operator!=</span><span>operator<</span> <span>operator<=</span> <span>operator></span> <span>operator>=</span> <span>operator<=></span></span></a></div>
|
|
<div><span class="t-lines"><span></span><span><span class="t-mark-rev t-until-cxx20">(C++20 中移除)</span></span><span><span class="t-mark-rev t-until-cxx20">(C++20 中移除)</span></span><span><span class="t-mark-rev t-until-cxx20">(C++20 中移除)</span></span><span><span class="t-mark-rev t-until-cxx20">(C++20 中移除)</span></span><span><span class="t-mark-rev t-until-cxx20">(C++20 中移除)</span></span><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>比较两个 <code>thread::id</code> 对象<br />
|
|
<span class="t-mark">(函数)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-thread-id-operator_ltlt.html"><span class="t-lines"><span>operator<<</span></span></a></div>
|
|
</div>
|
|
</td>
|
|
<td>序列化 <code>thread::id</code> 对象<br />
|
|
<span class="t-mark">(函数模板)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc-header">
|
|
<td colspan="2">
|
|
<div>定义于命名空间 <code>std::this_thread</code></div>
|
|
</td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-yield.html"><span class="t-lines"><span>yield</span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>建议实现重新调度各执行线程<br />
|
|
<span class="t-mark">(函数)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-get_id.html"><span class="t-lines"><span>get_id</span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>返回当前线程的线程 id<br />
|
|
<span class="t-mark">(函数)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-sleep_for.html"><span class="t-lines"><span>sleep_for</span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>使当前线程的执行停止指定的时间段<br />
|
|
<span class="t-mark">(函数)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-thread-sleep_until.html"><span class="t-lines"><span>sleep_until</span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>使当前线程的执行停止直到指定的时间点<br />
|
|
<span class="t-mark">(函数)</span></td>
|
|
</tr>
|
|
</table>
|
|
<h3><span class="mw-headline" id=".E6.A6.82.E8.A6.81">概要</span></h3>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="co2">#include <compare></span>
|
|
|
|
<span class="kw1">namespace</span> std <span class="br0">{</span>
|
|
<span class="kw1">class</span> thread<span class="sy4">;</span>
|
|
|
|
<span class="kw4">void</span> swap<span class="br0">(</span>thread<span class="sy3">&</span> x, thread<span class="sy3">&</span> y<span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 类 jthread</span>
|
|
<span class="kw1">class</span> jthread<span class="sy4">;</span>
|
|
|
|
<span class="kw1">namespace</span> this_thread <span class="br0">{</span>
|
|
thread<span class="sy4">::</span><span class="me2">id</span> get_id<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
|
|
<span class="kw4">void</span> yield<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> Clock, <span class="kw1">class</span> Duration<span class="sy1">></span>
|
|
<span class="kw4">void</span> sleep_until<span class="br0">(</span><span class="kw4">const</span> chrono<span class="sy4">::</span><span class="me2">time_point</span><span class="sy1"><</span>Clock, Duration<span class="sy1">></span><span class="sy3">&</span> abs_time<span class="br0">)</span><span class="sy4">;</span>
|
|
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> Rep, <span class="kw1">class</span> Period<span class="sy1">></span>
|
|
<span class="kw4">void</span> sleep_for<span class="br0">(</span><span class="kw4">const</span> chrono<span class="sy4">::</span><span class="me2">duration</span><span class="sy1"><</span>Rep, Period<span class="sy1">></span><span class="sy3">&</span> rel_time<span class="br0">)</span><span class="sy4">;</span>
|
|
<span class="br0">}</span>
|
|
<span class="br0">}</span></pre></div>
|
|
</div>
|
|
<h4><span class="mw-headline" id=".E7.B1.BB_std::thread">类 <span class="t-lc"><a href="cpp-thread-thread.html">std::thread</a></span></span></h4>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="kw1">namespace</span> std <span class="br0">{</span>
|
|
<span class="kw1">class</span> thread <span class="br0">{</span>
|
|
<span class="kw1">public</span><span class="sy4">:</span>
|
|
<span class="co1">// 类型</span>
|
|
<span class="kw1">class</span> id<span class="sy4">;</span>
|
|
<span class="kw1">using</span> native_handle_type <span class="sy1">=</span> <span class="coMULTI">/* 由实现定义 */</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 构造/复制/销毁</span>
|
|
thread<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> F, <span class="kw1">class</span>... <span class="me1">Args</span><span class="sy1">></span> <span class="kw1">explicit</span> thread<span class="br0">(</span>F<span class="sy3">&&</span> f, Args<span class="sy3">&&</span>... <span class="me1">args</span><span class="br0">)</span><span class="sy4">;</span>
|
|
~thread<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
|
thread<span class="br0">(</span><span class="kw4">const</span> thread<span class="sy3">&</span><span class="br0">)</span> <span class="sy1">=</span> delete<span class="sy4">;</span>
|
|
thread<span class="br0">(</span>thread<span class="sy3">&&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
thread<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span><span class="kw4">const</span> thread<span class="sy3">&</span><span class="br0">)</span> <span class="sy1">=</span> delete<span class="sy4">;</span>
|
|
thread<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span>thread<span class="sy3">&&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 成员</span>
|
|
<span class="kw4">void</span> swap<span class="br0">(</span>thread<span class="sy3">&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="kw4">bool</span> joinable<span class="br0">(</span><span class="br0">)</span> <span class="kw4">const</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="kw4">void</span> join<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
|
<span class="kw4">void</span> detach<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
|
id get_id<span class="br0">(</span><span class="br0">)</span> <span class="kw4">const</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
native_handle_type native_handle<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 静态成员</span>
|
|
<span class="kw4">static</span> <span class="kw4">unsigned</span> <span class="kw4">int</span> hardware_concurrency<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="br0">}</span><span class="sy4">;</span>
|
|
<span class="br0">}</span></pre></div>
|
|
</div>
|
|
<h4><span class="mw-headline" id=".E7.B1.BB_std::jthread">类 <span class="t-lc">std::jthread</span></span></h4>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="kw1">namespace</span> std <span class="br0">{</span>
|
|
<span class="kw1">class</span> jthread <span class="br0">{</span>
|
|
<span class="kw1">public</span><span class="sy4">:</span>
|
|
<span class="co1">// 类型</span>
|
|
<span class="kw1">using</span> id <span class="sy1">=</span> thread<span class="sy4">::</span><span class="me2">id</span><span class="sy4">;</span>
|
|
<span class="kw1">using</span> native_handle_type <span class="sy1">=</span> thread<span class="sy4">::</span><span class="me2">native_handle_type</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 构造函数、移动与赋值</span>
|
|
jthread<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> F, <span class="kw1">class</span>... <span class="me1">Args</span><span class="sy1">></span> <span class="kw1">explicit</span> jthread<span class="br0">(</span>F<span class="sy3">&&</span> f, Args<span class="sy3">&&</span>... <span class="me1">args</span><span class="br0">)</span><span class="sy4">;</span>
|
|
~jthread<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
|
jthread<span class="br0">(</span><span class="kw4">const</span> jthread<span class="sy3">&</span><span class="br0">)</span> <span class="sy1">=</span> delete<span class="sy4">;</span>
|
|
jthread<span class="br0">(</span>jthread<span class="sy3">&&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
jthread<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span><span class="kw4">const</span> jthread<span class="sy3">&</span><span class="br0">)</span> <span class="sy1">=</span> delete<span class="sy4">;</span>
|
|
jthread<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span>jthread<span class="sy3">&&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 成员</span>
|
|
<span class="kw4">void</span> swap<span class="br0">(</span>jthread<span class="sy3">&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="br0">[</span><span class="br0">[</span>nodiscard<span class="br0">]</span><span class="br0">]</span> <span class="kw4">bool</span> joinable<span class="br0">(</span><span class="br0">)</span> <span class="kw4">const</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="kw4">void</span> join<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
|
<span class="kw4">void</span> detach<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
|
<span class="br0">[</span><span class="br0">[</span>nodiscard<span class="br0">]</span><span class="br0">]</span> id get_id<span class="br0">(</span><span class="br0">)</span> <span class="kw4">const</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="br0">[</span><span class="br0">[</span>nodiscard<span class="br0">]</span><span class="br0">]</span> native_handle_type native_handle<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 停止记号处理</span>
|
|
<span class="br0">[</span><span class="br0">[</span>nodiscard<span class="br0">]</span><span class="br0">]</span> stop_source get_stop_source<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="br0">[</span><span class="br0">[</span>nodiscard<span class="br0">]</span><span class="br0">]</span> stop_token get_stop_token<span class="br0">(</span><span class="br0">)</span> <span class="kw4">const</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="kw4">bool</span> request_stop<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 特化的算法</span>
|
|
<span class="kw1">friend</span> <span class="kw4">void</span> swap<span class="br0">(</span>jthread<span class="sy3">&</span> lhs, jthread<span class="sy3">&</span> rhs<span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 静态成员</span>
|
|
<span class="br0">[</span><span class="br0">[</span>nodiscard<span class="br0">]</span><span class="br0">]</span> <span class="kw4">static</span> <span class="kw4">unsigned</span> <span class="kw4">int</span> hardware_concurrency<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
|
|
<span class="kw1">private</span><span class="sy4">:</span>
|
|
stop_source ssource<span class="sy4">;</span> <span class="co1">// 仅用于阐释</span>
|
|
<span class="br0">}</span><span class="sy4">;</span>
|
|
<span class="br0">}</span></pre></div>
|
|
</div>
|
|
<h4><span class="mw-headline" id=".E7.B1.BB_std::thread::id">类 <span class="t-lc"><a href="cpp-thread-thread-id.html">std::thread::id</a></span></span></h4>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="kw1">namespace</span> std <span class="br0">{</span>
|
|
<span class="kw1">class</span> thread<span class="sy4">::</span><span class="me2">id</span> <span class="br0">{</span>
|
|
<span class="kw1">public</span><span class="sy4">:</span>
|
|
id<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
<span class="br0">}</span><span class="sy4">;</span>
|
|
|
|
<span class="kw4">bool</span> operator<span class="sy1">==</span><span class="br0">(</span>thread<span class="sy4">::</span><span class="me2">id</span> x, thread<span class="sy4">::</span><span class="me2">id</span> y<span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
strong_ordering operator<span class="sy1"><=></span><span class="br0">(</span>thread<span class="sy4">::</span><span class="me2">id</span> x, thread<span class="sy4">::</span><span class="me2">id</span> y<span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
|
|
|
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> charT, <span class="kw1">class</span> traits<span class="sy1">></span>
|
|
basic_ostream<span class="sy1"><</span>charT, traits<span class="sy1">></span><span class="sy3">&</span>
|
|
operator<span class="sy1"><<</span><span class="br0">(</span>basic_ostream<span class="sy1"><</span>charT, traits<span class="sy1">></span><span class="sy3">&</span> out, thread<span class="sy4">::</span><span class="me2">id</span> id<span class="br0">)</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 散列支持</span>
|
|
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> T<span class="sy1">></span> <span class="kw1">struct</span> hash<span class="sy4">;</span>
|
|
<span class="kw1">template</span><span class="sy1"><></span> <span class="kw1">struct</span> hash<span class="sy1"><</span>thread<span class="sy4">::</span><span class="me2">id</span><span class="sy1">></span><span class="sy4">;</span>
|
|
<span class="br0">}</span></pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|