上传cppreference
This commit is contained in:
198
web/cppreference-zh/chmhelp/cpp-header-stop_token.html
Normal file
198
web/cppreference-zh/chmhelp/cpp-header-stop_token.html
Normal file
@@ -0,0 +1,198 @@
|
||||
<!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>标准库头文件 <stop_token></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_stop_token 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> <stop_token></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=".E7.B1.BB">类</span></h3>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="t-dsc">
|
||||
<td>
|
||||
<div class="t-dsc-member-div">
|
||||
<div><a href="cpp-thread-stop_token.html"><span class="t-lines"><span>stop_token</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">std::jthread</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-stop_source.html"><span class="t-lines"><span>stop_source</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">std::jthread</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-stop_callback.html"><span class="t-lines"><span>stop_callback</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">std::jthread</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-stop_source-nostopstate_t.html"><span class="t-lines"><span>nostopstate_t</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>用于 <code>stop_source</code> 构造函数的占位符类型<br />
|
||||
<span class="t-mark">(类)</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<h3><span class="mw-headline" id=".E5.B8.B8.E9.87.8F">常量</span></h3>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="t-dsc">
|
||||
<td>
|
||||
<div class="t-dsc-member-div">
|
||||
<div><a href="cpp-thread-stop_source-nostopstate.html"><span class="t-lines"><span>nostopstate</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>用于 <code>stop_source</code> 构造函数的 <code>std::nostopstate_t</code> 实例<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="kw1">namespace</span> std <span class="br0">{</span>
|
||||
<span class="co1">// 类 stop_token</span>
|
||||
<span class="kw1">class</span> stop_token<span class="sy4">;</span>
|
||||
|
||||
<span class="co1">// 类 stop_source</span>
|
||||
<span class="kw1">class</span> stop_source<span class="sy4">;</span>
|
||||
|
||||
<span class="co1">// 无共享停止状态指示器</span>
|
||||
<span class="kw1">struct</span> nostopstate_t <span class="br0">{</span>
|
||||
<span class="kw1">explicit</span> nostopstate_t<span class="br0">(</span><span class="br0">)</span> <span class="sy1">=</span> <span class="kw1">default</span><span class="sy4">;</span>
|
||||
<span class="br0">}</span><span class="sy4">;</span>
|
||||
<span class="kw1">inline</span> <span class="kw4">constexpr</span> nostopstate_t nostopstate<span class="br0">{</span><span class="br0">}</span><span class="sy4">;</span>
|
||||
|
||||
<span class="co1">// 类 stop_callback</span>
|
||||
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> Callback<span class="sy1">></span>
|
||||
<span class="kw1">class</span> stop_callback<span class="sy4">;</span>
|
||||
<span class="br0">}</span></pre></div>
|
||||
</div>
|
||||
<h4><span class="mw-headline" id=".E7.B1.BB_std::stop_token">类 <span class="t-lc">std::stop_token</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> stop_token <span class="br0">{</span>
|
||||
<span class="kw1">public</span><span class="sy4">:</span>
|
||||
<span class="co1">// 构造函数、复制与赋值</span>
|
||||
stop_token<span class="br0">(</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
|
||||
stop_token<span class="br0">(</span><span class="kw4">const</span> stop_token<span class="sy3">&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
stop_token<span class="br0">(</span>stop_token<span class="sy3">&&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
stop_token<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span><span class="kw4">const</span> stop_token<span class="sy3">&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
stop_token<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span>stop_token<span class="sy3">&&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
~stop_token<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
||||
<span class="kw4">void</span> swap<span class="br0">(</span>stop_token<span class="sy3">&</span><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">bool</span> stop_requested<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> <span class="kw4">bool</span> stop_possible<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>
|
||||
<span class="kw1">friend</span> <span class="kw4">bool</span> operator<span class="sy1">==</span><span class="br0">(</span><span class="kw4">const</span> stop_token<span class="sy3">&</span> lhs, <span class="kw4">const</span> stop_token<span class="sy3">&</span> rhs<span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
<span class="kw1">friend</span> <span class="kw4">void</span> swap<span class="br0">(</span>stop_token<span class="sy3">&</span> lhs, stop_token<span class="sy3">&</span> rhs<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::stop_source">类 <span class="t-lc">std::stop_source</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="co1">// 无共享停止状态指示器</span>
|
||||
<span class="kw1">struct</span> nostopstate_t <span class="br0">{</span>
|
||||
<span class="kw1">explicit</span> nostopstate_t<span class="br0">(</span><span class="br0">)</span> <span class="sy1">=</span> <span class="kw1">default</span><span class="sy4">;</span>
|
||||
<span class="br0">}</span><span class="sy4">;</span>
|
||||
<span class="kw1">inline</span> <span class="kw4">constexpr</span> nostopstate_t nostopstate<span class="br0">{</span><span class="br0">}</span><span class="sy4">;</span>
|
||||
|
||||
<span class="kw1">class</span> stop_source <span class="br0">{</span>
|
||||
<span class="kw1">public</span><span class="sy4">:</span>
|
||||
<span class="co1">// 构造函数、复制与赋值</span>
|
||||
stop_source<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
||||
<span class="kw1">explicit</span> stop_source<span class="br0">(</span>nostopstate_t<span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
|
||||
stop_source<span class="br0">(</span><span class="kw4">const</span> stop_source<span class="sy3">&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
stop_source<span class="br0">(</span>stop_source<span class="sy3">&&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
stop_source<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span><span class="kw4">const</span> stop_source<span class="sy3">&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
stop_source<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span>stop_source<span class="sy3">&&</span><span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
~stop_source<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
||||
<span class="kw4">void</span> swap<span class="br0">(</span>stop_source<span class="sy3">&</span><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> stop_token get_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="br0">[</span><span class="br0">[</span>nodiscard<span class="br0">]</span><span class="br0">]</span> <span class="kw4">bool</span> stop_possible<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> <span class="kw4">bool</span> stop_requested<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="br0">[</span><span class="br0">[</span>nodiscard<span class="br0">]</span><span class="br0">]</span> <span class="kw1">friend</span> <span class="kw4">bool</span>
|
||||
operator<span class="sy1">==</span><span class="br0">(</span><span class="kw4">const</span> stop_source<span class="sy3">&</span> lhs, <span class="kw4">const</span> stop_source<span class="sy3">&</span> rhs<span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span>
|
||||
<span class="kw1">friend</span> <span class="kw4">void</span> swap<span class="br0">(</span>stop_source<span class="sy3">&</span> lhs, stop_source<span class="sy3">&</span> rhs<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.E6.A8.A1.E6.9D.BF_std::stop_callback">类模板 <span class="t-lc">std::stop_callback</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">template</span><span class="sy1"><</span><span class="kw1">class</span> Callback<span class="sy1">></span>
|
||||
<span class="kw1">class</span> stop_callback <span class="br0">{</span>
|
||||
<span class="kw1">public</span><span class="sy4">:</span>
|
||||
<span class="kw1">using</span> callback_type <span class="sy1">=</span> Callback<span class="sy4">;</span>
|
||||
|
||||
<span class="co1">// 构造函数与析构函数</span>
|
||||
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> C<span class="sy1">></span>
|
||||
<span class="kw1">explicit</span> stop_callback<span class="br0">(</span><span class="kw4">const</span> stop_token<span class="sy3">&</span> st, C<span class="sy3">&&</span> cb<span class="br0">)</span>
|
||||
<span class="kw1">noexcept</span><span class="br0">(</span>is_nothrow_constructible_v<span class="sy1"><</span>Callback, C<span class="sy1">></span><span class="br0">)</span><span class="sy4">;</span>
|
||||
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> C<span class="sy1">></span>
|
||||
<span class="kw1">explicit</span> stop_callback<span class="br0">(</span>stop_token<span class="sy3">&&</span> st, C<span class="sy3">&&</span> cb<span class="br0">)</span>
|
||||
<span class="kw1">noexcept</span><span class="br0">(</span>is_nothrow_constructible_v<span class="sy1"><</span>Callback, C<span class="sy1">></span><span class="br0">)</span><span class="sy4">;</span>
|
||||
~stop_callback<span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
||||
|
||||
stop_callback<span class="br0">(</span><span class="kw4">const</span> stop_callback<span class="sy3">&</span><span class="br0">)</span> <span class="sy1">=</span> delete<span class="sy4">;</span>
|
||||
stop_callback<span class="br0">(</span>stop_callback<span class="sy3">&&</span><span class="br0">)</span> <span class="sy1">=</span> delete<span class="sy4">;</span>
|
||||
stop_callback<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span><span class="kw4">const</span> stop_callback<span class="sy3">&</span><span class="br0">)</span> <span class="sy1">=</span> delete<span class="sy4">;</span>
|
||||
stop_callback<span class="sy3">&</span> operator<span class="sy1">=</span><span class="br0">(</span>stop_callback<span class="sy3">&&</span><span class="br0">)</span> <span class="sy1">=</span> delete<span class="sy4">;</span>
|
||||
|
||||
<span class="kw1">private</span><span class="sy4">:</span>
|
||||
Callback callback<span class="sy4">;</span> <span class="co1">// 仅用于阐释</span>
|
||||
<span class="br0">}</span><span class="sy4">;</span>
|
||||
|
||||
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> Callback<span class="sy1">></span>
|
||||
stop_callback<span class="br0">(</span>stop_token, Callback<span class="br0">)</span> <span class="sy2">-</span><span class="sy1">></span> stop_callback<span class="sy1"><</span>Callback<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>
|
||||
Reference in New Issue
Block a user