taskflow/docs/classtf_1_1Future.html at task_isolation · ModuleWorks/taskflow · GitHub

History

188 lines (184 loc) · 13 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

<!DOCTYPE html>

<head>

<title>tf::Future class | Taskflow QuickStart</title>

</head>

<body>

<a href="https://taskflow.github.io"><img src="taskflow_logo.png" alt="" />Taskflow</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">QuickStart</a>

</span>

</svg></a>

</div>

<li><a href="pages.html">Handbook</a></li>

<li><a href="namespaces.html">Namespaces</a></li>

</ol>

<li><a href="annotated.html">Classes</a></li>

<li><a href="files.html">Files</a></li>

</svg></a></li>

</ol>

</div>

</nav></header>

<h1>

<div class="m-doc-include m-code m-inverted m-right-m m-text-right"><span class="cp">#include</span> <a class="cpf" href="core_2taskflow_8hpp.html"><taskflow/core/taskflow.hpp></a></div>

<div class="m-doc-template">template<typename T></div>

<span class="m-breadcrumb"><a href="namespacetf.html">tf</a>::<wbr/></span>Future <span class="m-thin">class</span>

</h1>

<p>class to access the result of an execution</p>

<h3>Contents</h3>

<ul>

<li>

Reference

<ul>

<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>

<li><a href="#pub-methods">Public functions</a></li>

</ul>

</li>

</ul>

</nav>

<p><a href="classtf_1_1Future.html" class="m-doc">tf::<wbr />Future</a> is a derived class from <a href="http://en.cppreference.com/w/cpp/thread/future.html" class="m-doc-external">std::<wbr />future</a> that will eventually hold the execution result of a submitted taskflow (<a href="classtf_1_1Executor.html#a519777f5783981d534e9e53b99712069" class="m-doc">tf::<wbr />Executor::<wbr />run</a>) In addition to the base methods inherited from <a href="http://en.cppreference.com/w/cpp/thread/future.html" class="m-doc-external">std::<wbr />future</a>, you can call <a href="#a3bf5f104864ab2590b6409712d3a469b" class="m-doc">tf::<wbr />Future::<wbr />cancel</a> to cancel the execution of the running taskflow associated with this future object. The following example cancels a submission of a taskflow that contains 1000 tasks each running one second.</p><pre class="m-code"><span class="n">tf</span><span class="o">::</span><span class="n">Executor</span><span class="w"> </span><span class="n">executor</span><span class="p">;</span>

<span class="n">tf</span><span class="o">::</span><span class="n">Taskflow</span><span class="w"> </span><span class="n">taskflow</span><span class="p">;</span>

<span class="w"> </span><span class="n">taskflow</span><span class="p">.</span><span class="n">emplace</span><span class="p">([](){</span>

<span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">this_thread</span><span class="o">::</span><span class="n">sleep_for</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">chrono</span><span class="o">::</span><span class="n">seconds</span><span class="p">(</span><span class="mi">1</span><span class="p">));</span>

<span class="c1">// submit the taskflow</span>

<span class="n">tf</span><span class="o">::</span><span class="n">Future</span><span class="w"> </span><span class="n">fu</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">executor</span><span class="p">.</span><span class="n">run</span><span class="p">(</span><span class="n">taskflow</span><span class="p">);</span>

<span class="c1">// request to cancel the submitted execution above</span>

<span class="n">fu</span><span class="p">.</span><span class="n">cancel</span><span class="p">();</span>

<span class="c1">// wait until the cancellation finishes</span>

<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>

<span class="m-doc-wrap-bumper"><a href="#a520785365a129094d7ecf11e217509db" class="m-doc-self">Future</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-info">defaulted</span></span>

</dt>

<dd>default constructor</dd>

<span class="m-doc-wrap-bumper"><a href="#ad22645f2bcbd2af449cfcd36eace9a1b" class="m-doc-self">Future</a>(</span><span class="m-doc-wrap">const <a href="classtf_1_1Future.html" class="m-doc">Future</a>&) <span class="m-label m-flat m-danger">deleted</span></span>

</dt>

<dd>disabled copy constructor</dd>

<span class="m-doc-wrap-bumper"><a href="#ae6c5f935a2062f58054b067d39f5e78a" class="m-doc-self">Future</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1Future.html" class="m-doc">Future</a>&&) <span class="m-label m-flat m-info">defaulted</span></span>

</dt>

<dd>default move constructor</dd>

</dl>

</section>

<h2><a href="#pub-methods">Public functions</a></h2>

<span class="m-doc-wrap-bumper">auto <a href="#a5203e9c97fad413b67f6f8ba1d322782" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap">const <a href="classtf_1_1Future.html" class="m-doc">Future</a>&) -> <a href="classtf_1_1Future.html" class="m-doc">Future</a>& <span class="m-label m-flat m-danger">deleted</span></span>

</dt>

<dd>disabled copy assignment</dd>

<span class="m-doc-wrap-bumper">auto <a href="#a52777516391d8c799ac93830fc47402a" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1Future.html" class="m-doc">Future</a>&&) -> <a href="classtf_1_1Future.html" class="m-doc">Future</a>& <span class="m-label m-flat m-info">defaulted</span></span>

</dt>

<dd>default move assignment</dd>

<dt>

<span class="m-doc-wrap-bumper">auto <a href="#a3bf5f104864ab2590b6409712d3a469b" class="m-doc">cancel</a>(</span><span class="m-doc-wrap">) -> bool</span>

</dt>

<dd>cancels the execution of the running taskflow associated with this future object</dd>

</dl>

</section>

<h2>Function documentation</h2>

<h3>

template<typename T>

</div>

<span class="m-doc-wrap-bumper">bool tf::<wbr />Future<T>::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a3bf5f104864ab2590b6409712d3a469b" class="m-doc-self">cancel</a>(</span><span class="m-doc-wrap">)</span></span>

</h3>

<p>cancels the execution of the running taskflow associated with this future object</p>

<tfoot>

<tr>

<th style="width: 1%">Returns</th>

<td><code>true</code> if the execution can be cancelled or <code>false</code> if the execution has already completed</td>

</tr>

</tfoot>

</table>

<p>When you request a cancellation, the executor will stop scheduling any tasks onwards. Tasks that are already running will continue to finish (non-preemptive). You can call tf::Future::wait to wait for the cancellation to complete.</p>

</div></section>

</section>

</div>

</article></main>

<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>

</div>

<form>

</form>

<p class="m-noindent">Search for symbols, directories, files, pages or

modules. You can omit any prefix from the symbol or file path; adding a

<code>:</code> or <code>/</code> suffix lists all members of given symbol or

directory.</p>

/ <span class="m-label m-dim">↑</span> to navigate through the list,

<span class="m-label m-dim">Enter</span> to go.

<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can

copy a link to the result using <span class="m-label m-dim">⌘</span>

<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>

<span class="m-label m-dim">M</span> produces a Markdown link.</p>

</div>

<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>

</div>

<p>Taskflow handbook is part of the <a href="https://taskflow.github.io">Taskflow project</a>, copyright © <a href="https://tsung-wei-huang.github.io/">Dr. Tsung-Wei Huang</a>, 2018–2025.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.12.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>

</div>

</nav></footer>

</body>

</html>

taskflow/docs/classtf_1_1Future.html at task_isolation · ModuleWorks/taskflow · GitHub

Expand file tree

Breadcrumbs

classtf_1_1Future.html

Latest commit

History

Breadcrumbs

classtf_1_1Future.html

File metadata and controls