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