cpp-taskflow/docs/classtf_1_1BoundedTaskQueue.html at master · ezhangle/cpp-taskflow · GitHub

History

281 lines (281 loc) · 15.5 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

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

<!DOCTYPE html>

<head>

<title>tf::BoundedTaskQueue 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="tsq_8hpp.html"><taskflow/core/tsq.hpp></a></div>

<div class="m-doc-template">template<typename T, size_t LogSize = <a href="taskflow_8hpp.html#a603f6f29f0f179ee85ecde7d5311a76e" class="m-doc">TF_<wbr />DEFAULT_<wbr />BOUNDED_<wbr />TASK_<wbr />QUEUE_<wbr />LOG_<wbr />SIZE</a>></div>

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

</h1>

<p>class to create a lock-free bounded single-producer multiple-consumer queue</p>

<thead>

<tr><th colspan="2">Template parameters</th></tr>

</thead>

<tbody>

<tr>

</tr>

<tr>

<td>LogSize</td>

<td>the base-2 logarithm of the queue size</td>

</tr>

</tbody>

</table>

<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>This class implements the work-stealing queue described in the paper, "Correct and Efficient Work-Stealing for Weak Memory Models," available at <a href="https://www.di.ens.fr/~zappa/readings/ppopp13.pdf">https:/<wbr />/<wbr />www.di.ens.fr/<wbr />~zappa/<wbr />readings/<wbr />ppopp13.pdf</a>.</p><p>Only the queue owner can perform pop and push operations, while others can steal data from the queue.</p>

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

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

</dt>

<dd>constructs the queue with a given capacity</dd>

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

</dt>

<dd>destructs the queue</dd>

</dl>

</section>

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

<span class="m-doc-wrap-bumper">auto <a href="#ae64ab051e9ce597482cb602ce967d459" class="m-doc-self">empty</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>

</dt>

<dd>queries if the queue is empty at the time of this call</dd>

<span class="m-doc-wrap-bumper">auto <a href="#a76620d4f4a85eae9e4626b9d83c61cb3" class="m-doc-self">size</a>(</span><span class="m-doc-wrap">) const -> size_t <span class="m-label m-flat m-success">noexcept</span></span>

</dt>

<dd>queries the number of items at the time of this call</dd>

<span class="m-doc-wrap-bumper">auto <a href="#ae3c7315f59e60f806225ee9cf8d55229" class="m-doc-self">capacity</a>(</span><span class="m-doc-wrap">) const -> size_t <span class="m-label m-flat m-primary">constexpr</span></span>

</dt>

<dd>queries the capacity of the queue</dd>

<dt>

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

</dt>

<dd>tries to insert an item to the queue</dd>

<dt>

<div class="m-doc-template">template<typename O, typename C></div>

<span class="m-doc-wrap-bumper">void <a href="#a9b0c93adcdeb0a876869027a211fdf62" class="m-doc">push</a>(</span><span class="m-doc-wrap">O&& item,

C&& on_full)</span>

</dt>

<dd>tries to insert an item to the queue or invoke the callable if fails</dd>

<dt>

</dt>

<dd>pops out an item from the queue</dd>

<dt>

<span class="m-doc-wrap-bumper">auto <a href="#ad2b4f8d262b0093ce08dea92c00fae1b" class="m-doc">steal</a>(</span><span class="m-doc-wrap">) -> T</span>

</dt>

<dd>steals an item from the queue</dd>

</dl>

</section>

<h2>Function documentation</h2>

<h3>

template<typename T, size_t LogSize>

template<typename O>

</div>

<span class="m-doc-wrap-bumper">bool tf::<wbr />BoundedTaskQueue<T, LogSize>::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af52edec086b5e1a9c090eff6a6a76dae" class="m-doc-self">try_push</a>(</span><span class="m-doc-wrap">O&& item)</span></span>

</h3>

<p>tries to insert an item to the queue</p>

<thead>

<tr><th colspan="2">Template parameters</th></tr>

</thead>

<tbody>

<tr>

</tr>

</tbody>

<thead>

<tr><th colspan="2">Parameters</th></tr>

</thead>

<tbody>

<tr>

<td>the item to perfect-forward to the queue</td>

</tr>

</tbody>

<tfoot>

<tr>

<th>Returns</th>

<td><code>true</code> if the insertion succeed or <code>false</code> (queue is full)</td>

</tr>

</tfoot>

</table>

<p>Only the owner thread can insert an item to the queue.</p>

</div></section>

<h3>

template<typename T, size_t LogSize>

template<typename O, typename C>

</div>

<span class="m-doc-wrap-bumper">void tf::<wbr />BoundedTaskQueue<T, LogSize>::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a9b0c93adcdeb0a876869027a211fdf62" class="m-doc-self">push</a>(</span><span class="m-doc-wrap">O&& item,

C&& on_full)</span></span>

</h3>

<p>tries to insert an item to the queue or invoke the callable if fails</p>

<thead>

<tr><th colspan="2">Template parameters</th></tr>

</thead>

<tbody>

<tr>

</tr>

<tr>

<td>callable type</td>

</tr>

</tbody>

<thead>

<tr><th colspan="2">Parameters</th></tr>

</thead>

<tbody>

<tr>

<td>the item to perfect-forward to the queue</td>

</tr>

<tr>

<td>callable to invoke when the queue is faull (insertion fails)</td>

</tr>

</tbody>

</table>

<p>Only the owner thread can insert an item to the queue.</p>

</div></section>

<h3>

template<typename T, size_t LogSize>

</div>

<span class="m-doc-wrap-bumper">T tf::<wbr />BoundedTaskQueue<T, LogSize>::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a2b9e1d2502b489656b89cb505e95e71b" class="m-doc-self">pop</a>(</span><span class="m-doc-wrap">)</span></span>

</h3>

<p>pops out an item from the queue</p>

<p>Only the owner thread can pop out an item from the queue. The return can be a <a href="https://en.cppreference.com/w/cpp/utility/optional/nullopt">std::<wbr />nullopt</a> if this operation failed (empty queue).</p>

</div></section>

<h3>

template<typename T, size_t LogSize>

</div>

<span class="m-doc-wrap-bumper">T tf::<wbr />BoundedTaskQueue<T, LogSize>::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad2b4f8d262b0093ce08dea92c00fae1b" class="m-doc-self">steal</a>(</span><span class="m-doc-wrap">)</span></span>

</h3>

<p>steals an item from the queue</p>

<p>Any threads can try to steal an item from the queue. The return can be a <a href="https://en.cppreference.com/w/cpp/utility/optional/nullopt">std::<wbr />nullopt</a> if this operation failed (not necessary empty).</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–2024.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>

</div>

</nav></footer>

</body>

</html>

cpp-taskflow/docs/classtf_1_1BoundedTaskQueue.html at master · ezhangle/cpp-taskflow · GitHub

Expand file tree

Breadcrumbs

classtf_1_1BoundedTaskQueue.html

Latest commit

History

Breadcrumbs

classtf_1_1BoundedTaskQueue.html

File metadata and controls