1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>system_executor</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="../reference.html" title="Reference"> 9<link rel="prev" href="system_context/_system_context.html" title="system_context::~system_context"> 10<link rel="next" href="system_timer.html" title="system_timer"> 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="system_context/_system_context.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="system_timer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.system_executor"></a><a class="link" href="system_executor.html" title="system_executor">system_executor</a> 28</h3></div></div></div> 29<p> 30 <a class="indexterm" name="boost_asio.indexterm.system_executor"></a> 31An executor that uses 32 arbitrary threads. 33 </p> 34<pre class="programlisting">typedef basic_system_executor< execution::blocking_t::possibly_t, execution::relationship_t::fork_t, std::allocator< void > > system_executor; 35</pre> 36<h5> 37<a name="boost_asio.reference.system_executor.h0"></a> 38 <span class="phrase"><a name="boost_asio.reference.system_executor.member_functions"></a></span><a class="link" href="system_executor.html#boost_asio.reference.system_executor.member_functions">Member Functions</a> 39 </h5> 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="basic_system_executor/basic_system_executor.html" title="basic_system_executor::basic_system_executor"><span class="bold"><strong>basic_system_executor</strong></span></a> <span class="silver">[constructor]</span> 62 </p> 63 </td> 64<td> 65 <p> 66 Default constructor. 67 </p> 68 </td> 69</tr> 70<tr> 71<td> 72 <p> 73 <a class="link" href="basic_system_executor/context.html" title="basic_system_executor::context"><span class="bold"><strong>context</strong></span></a> 74 </p> 75 </td> 76<td> 77 <p> 78 Obtain the underlying execution context. 79 </p> 80 </td> 81</tr> 82<tr> 83<td> 84 <p> 85 <a class="link" href="basic_system_executor/defer.html" title="basic_system_executor::defer"><span class="bold"><strong>defer</strong></span></a> 86 </p> 87 </td> 88<td> 89 <p> 90 Request the system executor to invoke the given function object. 91 </p> 92 </td> 93</tr> 94<tr> 95<td> 96 <p> 97 <a class="link" href="basic_system_executor/dispatch.html" title="basic_system_executor::dispatch"><span class="bold"><strong>dispatch</strong></span></a> 98 </p> 99 </td> 100<td> 101 <p> 102 Request the system executor to invoke the given function object. 103 </p> 104 </td> 105</tr> 106<tr> 107<td> 108 <p> 109 <a class="link" href="basic_system_executor/execute.html" title="basic_system_executor::execute"><span class="bold"><strong>execute</strong></span></a> 110 </p> 111 </td> 112<td> 113 <p> 114 Execution function. 115 </p> 116 </td> 117</tr> 118<tr> 119<td> 120 <p> 121 <a class="link" href="basic_system_executor/on_work_finished.html" title="basic_system_executor::on_work_finished"><span class="bold"><strong>on_work_finished</strong></span></a> 122 </p> 123 </td> 124<td> 125 <p> 126 Inform the executor that some work is no longer outstanding. 127 </p> 128 </td> 129</tr> 130<tr> 131<td> 132 <p> 133 <a class="link" href="basic_system_executor/on_work_started.html" title="basic_system_executor::on_work_started"><span class="bold"><strong>on_work_started</strong></span></a> 134 </p> 135 </td> 136<td> 137 <p> 138 Inform the executor that it has some outstanding work to do. 139 </p> 140 </td> 141</tr> 142<tr> 143<td> 144 <p> 145 <a class="link" href="basic_system_executor/post.html" title="basic_system_executor::post"><span class="bold"><strong>post</strong></span></a> 146 </p> 147 </td> 148<td> 149 <p> 150 Request the system executor to invoke the given function object. 151 </p> 152 </td> 153</tr> 154<tr> 155<td> 156 <p> 157 <a class="link" href="basic_system_executor/query.html" title="basic_system_executor::query"><span class="bold"><strong>query</strong></span></a> 158 </p> 159 </td> 160<td> 161 <p> 162 Query the current value of the allocator property. <br> <span class="silver"> —</span><br> 163 Query the occupancy (recommended number of work items) for the 164 system context. 165 </p> 166 </td> 167</tr> 168<tr> 169<td> 170 <p> 171 <a class="link" href="basic_system_executor/query__static.html" title="basic_system_executor::query"><span class="bold"><strong>query</strong></span></a> <span class="silver">[static]</span> 172 </p> 173 </td> 174<td> 175 <p> 176 Query the current value of the mapping property. <br> <span class="silver"> —</span><br> 177 Query the current value of the context property. <br> <span class="silver"> —</span><br> 178 Query the current value of the blocking property. <br> <span class="silver"> —</span><br> 179 Query the current value of the relationship property. 180 </p> 181 </td> 182</tr> 183<tr> 184<td> 185 <p> 186 <a class="link" href="basic_system_executor/require.html" title="basic_system_executor::require"><span class="bold"><strong>require</strong></span></a> 187 </p> 188 </td> 189<td> 190 <p> 191 Obtain an executor with the blocking.possibly property. <br> 192 <span class="silver"> —</span><br> Obtain an executor with the blocking.always property. <br> 193 <span class="silver"> —</span><br> Obtain an executor with the blocking.never property. <br> 194 <span class="silver"> —</span><br> Obtain an executor with the relationship.continuation property. 195 <br> <span class="silver"> —</span><br> Obtain an executor with the relationship.fork property. 196 <br> <span class="silver"> —</span><br> Obtain an executor with the specified allocator property. 197 <br> <span class="silver"> —</span><br> Obtain an executor with the default allocator property. 198 </p> 199 </td> 200</tr> 201</tbody> 202</table></div> 203<h5> 204<a name="boost_asio.reference.system_executor.h1"></a> 205 <span class="phrase"><a name="boost_asio.reference.system_executor.friends"></a></span><a class="link" href="system_executor.html#boost_asio.reference.system_executor.friends">Friends</a> 206 </h5> 207<div class="informaltable"><table class="table"> 208<colgroup> 209<col> 210<col> 211</colgroup> 212<thead><tr> 213<th> 214 <p> 215 Name 216 </p> 217 </th> 218<th> 219 <p> 220 Description 221 </p> 222 </th> 223</tr></thead> 224<tbody> 225<tr> 226<td> 227 <p> 228 <a class="link" href="basic_system_executor/operator_not__eq_.html" title="basic_system_executor::operator!="><span class="bold"><strong>operator!=</strong></span></a> 229 </p> 230 </td> 231<td> 232 <p> 233 Compare two executors for inequality. 234 </p> 235 </td> 236</tr> 237<tr> 238<td> 239 <p> 240 <a class="link" href="basic_system_executor/operator_eq__eq_.html" title="basic_system_executor::operator=="><span class="bold"><strong>operator==</strong></span></a> 241 </p> 242 </td> 243<td> 244 <p> 245 Compare two executors for equality. 246 </p> 247 </td> 248</tr> 249</tbody> 250</table></div> 251<p> 252 The system executor represents an execution context where functions are permitted 253 to run on arbitrary threads. When the blocking.never property is established, 254 the system executor will schedule the function to run on an unspecified system 255 thread pool. When either blocking.possibly or blocking.always is established, 256 the executor invokes the function immediately. 257 </p> 258<p> 259 The system executor represents an execution context where functions are permitted 260 to run on arbitrary threads. When the blocking.never property is established, 261 the system executor will schedule the function to run on an unspecified system 262 thread pool. When either blocking.possibly or blocking.always is established, 263 the executor invokes the function immediately. 264 </p> 265<h5> 266<a name="boost_asio.reference.system_executor.h2"></a> 267 <span class="phrase"><a name="boost_asio.reference.system_executor.requirements"></a></span><a class="link" href="system_executor.html#boost_asio.reference.system_executor.requirements">Requirements</a> 268 </h5> 269<p> 270 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/system_executor.hpp</code> 271 </p> 272<p> 273 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 274 </p> 275</div> 276<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 277<td align="left"></td> 278<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 279 Kohlhoff<p> 280 Distributed under the Boost Software License, Version 1.0. (See accompanying 281 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>) 282 </p> 283</div></td> 284</tr></table> 285<hr> 286<div class="spirit-nav"> 287<a accesskey="p" href="system_context/_system_context.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="system_timer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 288</div> 289</body> 290</html> 291
