1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>thread_pool::scheduler_type</title> 5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../thread_pool.html" title="thread_pool"> 9<link rel="prev" href="scheduler.html" title="thread_pool::scheduler"> 10<link rel="next" href="shutdown.html" title="thread_pool::shutdown"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="scheduler.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread_pool.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="shutdown.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="boost_asio.reference.thread_pool.scheduler_type"></a><a class="link" href="scheduler_type.html" title="thread_pool::scheduler_type">thread_pool::scheduler_type</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="boost_asio.indexterm.thread_pool.scheduler_type"></a> 31Scheduler 32 used to schedule receivers on a thread pool. 33 </p> 34<pre class="programlisting">typedef basic_executor_type< std::allocator< void >, 0 > scheduler_type; 35</pre> 36<h6> 37<a name="boost_asio.reference.thread_pool.scheduler_type.h0"></a> 38 <span class="phrase"><a name="boost_asio.reference.thread_pool.scheduler_type.types"></a></span><a class="link" href="scheduler_type.html#boost_asio.reference.thread_pool.scheduler_type.types">Types</a> 39 </h6> 40<div class="informaltable"><table class="table"> 41<colgroup> 42<col> 43<col> 44</colgroup> 45<thead><tr> 46<th> 47 <p> 48 Name 49 </p> 50 </th> 51<th> 52 <p> 53 Description 54 </p> 55 </th> 56</tr></thead> 57<tbody> 58<tr> 59<td> 60 <p> 61 <a class="link" href="../thread_pool__basic_executor_type/index_type.html" title="thread_pool::basic_executor_type::index_type"><span class="bold"><strong>index_type</strong></span></a> 62 </p> 63 </td> 64<td> 65 <p> 66 The bulk execution index type. 67 </p> 68 </td> 69</tr> 70<tr> 71<td> 72 <p> 73 <a class="link" href="../thread_pool__basic_executor_type/sender_type.html" title="thread_pool::basic_executor_type::sender_type"><span class="bold"><strong>sender_type</strong></span></a> 74 </p> 75 </td> 76<td> 77 <p> 78 The sender type, when this type is used as a scheduler. 79 </p> 80 </td> 81</tr> 82<tr> 83<td> 84 <p> 85 <a class="link" href="../thread_pool__basic_executor_type/shape_type.html" title="thread_pool::basic_executor_type::shape_type"><span class="bold"><strong>shape_type</strong></span></a> 86 </p> 87 </td> 88<td> 89 <p> 90 The bulk execution shape type. 91 </p> 92 </td> 93</tr> 94</tbody> 95</table></div> 96<h6> 97<a name="boost_asio.reference.thread_pool.scheduler_type.h1"></a> 98 <span class="phrase"><a name="boost_asio.reference.thread_pool.scheduler_type.member_functions"></a></span><a class="link" href="scheduler_type.html#boost_asio.reference.thread_pool.scheduler_type.member_functions">Member 99 Functions</a> 100 </h6> 101<div class="informaltable"><table class="table"> 102<colgroup> 103<col> 104<col> 105</colgroup> 106<thead><tr> 107<th> 108 <p> 109 Name 110 </p> 111 </th> 112<th> 113 <p> 114 Description 115 </p> 116 </th> 117</tr></thead> 118<tbody> 119<tr> 120<td> 121 <p> 122 <a class="link" href="../thread_pool__basic_executor_type/basic_executor_type.html" title="thread_pool::basic_executor_type::basic_executor_type"><span class="bold"><strong>basic_executor_type</strong></span></a> <span class="silver">[constructor]</span> 123 </p> 124 </td> 125<td> 126 <p> 127 Copy constructor. <br> <span class="silver"> —</span><br> Move constructor. 128 </p> 129 </td> 130</tr> 131<tr> 132<td> 133 <p> 134 <a class="link" href="../thread_pool__basic_executor_type/bulk_execute.html" title="thread_pool::basic_executor_type::bulk_execute"><span class="bold"><strong>bulk_execute</strong></span></a> 135 </p> 136 </td> 137<td> 138 <p> 139 Bulk execution function. 140 </p> 141 </td> 142</tr> 143<tr> 144<td> 145 <p> 146 <a class="link" href="../thread_pool__basic_executor_type/connect.html" title="thread_pool::basic_executor_type::connect"><span class="bold"><strong>connect</strong></span></a> 147 </p> 148 </td> 149<td> 150 <p> 151 Connect function. 152 </p> 153 </td> 154</tr> 155<tr> 156<td> 157 <p> 158 <a class="link" href="../thread_pool__basic_executor_type/context.html" title="thread_pool::basic_executor_type::context"><span class="bold"><strong>context</strong></span></a> 159 </p> 160 </td> 161<td> 162 <p> 163 Obtain the underlying execution context. 164 </p> 165 </td> 166</tr> 167<tr> 168<td> 169 <p> 170 <a class="link" href="../thread_pool__basic_executor_type/defer.html" title="thread_pool::basic_executor_type::defer"><span class="bold"><strong>defer</strong></span></a> 171 </p> 172 </td> 173<td> 174 <p> 175 Request the thread pool to invoke the given function object. 176 </p> 177 </td> 178</tr> 179<tr> 180<td> 181 <p> 182 <a class="link" href="../thread_pool__basic_executor_type/dispatch.html" title="thread_pool::basic_executor_type::dispatch"><span class="bold"><strong>dispatch</strong></span></a> 183 </p> 184 </td> 185<td> 186 <p> 187 Request the thread pool to invoke the given function object. 188 </p> 189 </td> 190</tr> 191<tr> 192<td> 193 <p> 194 <a class="link" href="../thread_pool__basic_executor_type/execute.html" title="thread_pool::basic_executor_type::execute"><span class="bold"><strong>execute</strong></span></a> 195 </p> 196 </td> 197<td> 198 <p> 199 Execution function. 200 </p> 201 </td> 202</tr> 203<tr> 204<td> 205 <p> 206 <a class="link" href="../thread_pool__basic_executor_type/on_work_finished.html" title="thread_pool::basic_executor_type::on_work_finished"><span class="bold"><strong>on_work_finished</strong></span></a> 207 </p> 208 </td> 209<td> 210 <p> 211 Inform the thread pool that some work is no longer outstanding. 212 </p> 213 </td> 214</tr> 215<tr> 216<td> 217 <p> 218 <a class="link" href="../thread_pool__basic_executor_type/on_work_started.html" title="thread_pool::basic_executor_type::on_work_started"><span class="bold"><strong>on_work_started</strong></span></a> 219 </p> 220 </td> 221<td> 222 <p> 223 Inform the thread pool that it has some outstanding work to do. 224 </p> 225 </td> 226</tr> 227<tr> 228<td> 229 <p> 230 <a class="link" href="../thread_pool__basic_executor_type/operator_eq_.html" title="thread_pool::basic_executor_type::operator="><span class="bold"><strong>operator=</strong></span></a> 231 </p> 232 </td> 233<td> 234 <p> 235 Assignment operator. <br> <span class="silver"> —</span><br> Move assignment operator. 236 </p> 237 </td> 238</tr> 239<tr> 240<td> 241 <p> 242 <a class="link" href="../thread_pool__basic_executor_type/post.html" title="thread_pool::basic_executor_type::post"><span class="bold"><strong>post</strong></span></a> 243 </p> 244 </td> 245<td> 246 <p> 247 Request the thread pool to invoke the given function object. 248 </p> 249 </td> 250</tr> 251<tr> 252<td> 253 <p> 254 <a class="link" href="../thread_pool__basic_executor_type/query.html" title="thread_pool::basic_executor_type::query"><span class="bold"><strong>query</strong></span></a> 255 </p> 256 </td> 257<td> 258 <p> 259 Query the current value of the context property. <br> <span class="silver"> —</span><br> 260 Query the current value of the blocking property. <br> <span class="silver"> —</span><br> 261 Query the current value of the relationship property. <br> 262 <span class="silver"> —</span><br> Query the current value of the allocator property. <br> 263 <span class="silver"> —</span><br> Query the occupancy (recommended number of work items) 264 for the pool. 265 </p> 266 </td> 267</tr> 268<tr> 269<td> 270 <p> 271 <a class="link" href="../thread_pool__basic_executor_type/query__static.html" title="thread_pool::basic_executor_type::query"><span class="bold"><strong>query</strong></span></a> <span class="silver">[static]</span> 272 </p> 273 </td> 274<td> 275 <p> 276 Query the current value of the bulk_guarantee property. <br> 277 <span class="silver"> —</span><br> Query the current value of the mapping property. <br> 278 <span class="silver"> —</span><br> Query the current value of the outstanding_work property. 279 </p> 280 </td> 281</tr> 282<tr> 283<td> 284 <p> 285 <a class="link" href="../thread_pool__basic_executor_type/require.html" title="thread_pool::basic_executor_type::require"><span class="bold"><strong>require</strong></span></a> 286 </p> 287 </td> 288<td> 289 <p> 290 Obtain an executor with the blocking.possibly property. <br> 291 <span class="silver"> —</span><br> Obtain an executor with the blocking.always property. 292 <br> <span class="silver"> —</span><br> Obtain an executor with the blocking.never property. 293 <br> <span class="silver"> —</span><br> Obtain an executor with the relationship.fork property. 294 <br> <span class="silver"> —</span><br> Obtain an executor with the relationship.continuation 295 property. <br> <span class="silver"> —</span><br> Obtain an executor with the outstanding_work.tracked 296 property. <br> <span class="silver"> —</span><br> Obtain an executor with the outstanding_work.untracked 297 property. <br> <span class="silver"> —</span><br> Obtain an executor with the specified 298 allocator property. <br> <span class="silver"> —</span><br> Obtain an executor with the 299 default allocator property. 300 </p> 301 </td> 302</tr> 303<tr> 304<td> 305 <p> 306 <a class="link" href="../thread_pool__basic_executor_type/running_in_this_thread.html" title="thread_pool::basic_executor_type::running_in_this_thread"><span class="bold"><strong>running_in_this_thread</strong></span></a> 307 </p> 308 </td> 309<td> 310 <p> 311 Determine whether the thread pool is running in the current thread. 312 </p> 313 </td> 314</tr> 315<tr> 316<td> 317 <p> 318 <a class="link" href="../thread_pool__basic_executor_type/schedule.html" title="thread_pool::basic_executor_type::schedule"><span class="bold"><strong>schedule</strong></span></a> 319 </p> 320 </td> 321<td> 322 <p> 323 Schedule function. 324 </p> 325 </td> 326</tr> 327<tr> 328<td> 329 <p> 330 <a class="link" href="../thread_pool__basic_executor_type/_basic_executor_type.html" title="thread_pool::basic_executor_type::~basic_executor_type"><span class="bold"><strong>~basic_executor_type</strong></span></a> <span class="silver">[destructor]</span> 331 </p> 332 </td> 333<td> 334 <p> 335 Destructor. 336 </p> 337 </td> 338</tr> 339</tbody> 340</table></div> 341<h6> 342<a name="boost_asio.reference.thread_pool.scheduler_type.h2"></a> 343 <span class="phrase"><a name="boost_asio.reference.thread_pool.scheduler_type.friends"></a></span><a class="link" href="scheduler_type.html#boost_asio.reference.thread_pool.scheduler_type.friends">Friends</a> 344 </h6> 345<div class="informaltable"><table class="table"> 346<colgroup> 347<col> 348<col> 349</colgroup> 350<thead><tr> 351<th> 352 <p> 353 Name 354 </p> 355 </th> 356<th> 357 <p> 358 Description 359 </p> 360 </th> 361</tr></thead> 362<tbody> 363<tr> 364<td> 365 <p> 366 <a class="link" href="../thread_pool__basic_executor_type/operator_not__eq_.html" title="thread_pool::basic_executor_type::operator!="><span class="bold"><strong>operator!=</strong></span></a> 367 </p> 368 </td> 369<td> 370 <p> 371 Compare two executors for inequality. 372 </p> 373 </td> 374</tr> 375<tr> 376<td> 377 <p> 378 <a class="link" href="../thread_pool__basic_executor_type/operator_eq__eq_.html" title="thread_pool::basic_executor_type::operator=="><span class="bold"><strong>operator==</strong></span></a> 379 </p> 380 </td> 381<td> 382 <p> 383 Compare two executors for equality. 384 </p> 385 </td> 386</tr> 387</tbody> 388</table></div> 389<h6> 390<a name="boost_asio.reference.thread_pool.scheduler_type.h3"></a> 391 <span class="phrase"><a name="boost_asio.reference.thread_pool.scheduler_type.requirements"></a></span><a class="link" href="scheduler_type.html#boost_asio.reference.thread_pool.scheduler_type.requirements">Requirements</a> 392 </h6> 393<p> 394 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/thread_pool.hpp</code> 395 </p> 396<p> 397 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 398 </p> 399</div> 400<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 401<td align="left"></td> 402<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 403 Kohlhoff<p> 404 Distributed under the Boost Software License, Version 1.0. (See accompanying 405 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 406 </p> 407</div></td> 408</tr></table> 409<hr> 410<div class="spirit-nav"> 411<a accesskey="p" href="scheduler.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread_pool.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="shutdown.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 412</div> 413</body> 414</html> 415
