• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>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="execution_context__service/shutdown.html" title="execution_context::service::shutdown">
10<link rel="next" href="executor/context.html" title="executor::context">
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="execution_context__service/shutdown.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="executor/context.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.executor"></a><a class="link" href="executor.html" title="executor">executor</a>
28</h3></div></div></div>
29<p>
30        Polymorphic wrapper for executors.
31      </p>
32<pre class="programlisting">class executor
33</pre>
34<h5>
35<a name="boost_asio.reference.executor.h0"></a>
36        <span class="phrase"><a name="boost_asio.reference.executor.types"></a></span><a class="link" href="executor.html#boost_asio.reference.executor.types">Types</a>
37      </h5>
38<div class="informaltable"><table class="table">
39<colgroup>
40<col>
41<col>
42</colgroup>
43<thead><tr>
44<th>
45                <p>
46                  Name
47                </p>
48              </th>
49<th>
50                <p>
51                  Description
52                </p>
53              </th>
54</tr></thead>
55<tbody>
56<tr>
57<td>
58                <p>
59                  <a class="link" href="executor__unspecified_bool_type_t.html" title="executor::unspecified_bool_type_t"><span class="bold"><strong>unspecified_bool_type_t</strong></span></a>
60                </p>
61              </td>
62<td>
63              </td>
64</tr>
65<tr>
66<td>
67                <p>
68                  <a class="link" href="executor/unspecified_bool_type.html" title="executor::unspecified_bool_type"><span class="bold"><strong>unspecified_bool_type</strong></span></a>
69                </p>
70              </td>
71<td>
72              </td>
73</tr>
74</tbody>
75</table></div>
76<h5>
77<a name="boost_asio.reference.executor.h1"></a>
78        <span class="phrase"><a name="boost_asio.reference.executor.member_functions"></a></span><a class="link" href="executor.html#boost_asio.reference.executor.member_functions">Member
79        Functions</a>
80      </h5>
81<div class="informaltable"><table class="table">
82<colgroup>
83<col>
84<col>
85</colgroup>
86<thead><tr>
87<th>
88                <p>
89                  Name
90                </p>
91              </th>
92<th>
93                <p>
94                  Description
95                </p>
96              </th>
97</tr></thead>
98<tbody>
99<tr>
100<td>
101                <p>
102                  <a class="link" href="executor/context.html" title="executor::context"><span class="bold"><strong>context</strong></span></a>
103                </p>
104              </td>
105<td>
106                <p>
107                  Obtain the underlying execution context.
108                </p>
109              </td>
110</tr>
111<tr>
112<td>
113                <p>
114                  <a class="link" href="executor/defer.html" title="executor::defer"><span class="bold"><strong>defer</strong></span></a>
115                </p>
116              </td>
117<td>
118                <p>
119                  Request the executor to invoke the given function object.
120                </p>
121              </td>
122</tr>
123<tr>
124<td>
125                <p>
126                  <a class="link" href="executor/dispatch.html" title="executor::dispatch"><span class="bold"><strong>dispatch</strong></span></a>
127                </p>
128              </td>
129<td>
130                <p>
131                  Request the executor to invoke the given function object.
132                </p>
133              </td>
134</tr>
135<tr>
136<td>
137                <p>
138                  <a class="link" href="executor/executor.html" title="executor::executor"><span class="bold"><strong>executor</strong></span></a> <span class="silver">[constructor]</span>
139                </p>
140              </td>
141<td>
142                <p>
143                  Default constructor. <br> <span class="silver"> —</span><br> Construct from nullptr. <br>
144                  <span class="silver"> —</span><br> Copy constructor. <br> <span class="silver"> —</span><br> Move constructor. <br>
145                  <span class="silver"> —</span><br> Construct a polymorphic wrapper for the specified executor.
146                  <br> <span class="silver"> —</span><br> Allocator-aware constructor to create a polymorphic
147                  wrapper for the specified executor.
148                </p>
149              </td>
150</tr>
151<tr>
152<td>
153                <p>
154                  <a class="link" href="executor/on_work_finished.html" title="executor::on_work_finished"><span class="bold"><strong>on_work_finished</strong></span></a>
155                </p>
156              </td>
157<td>
158                <p>
159                  Inform the executor that some work is no longer outstanding.
160                </p>
161              </td>
162</tr>
163<tr>
164<td>
165                <p>
166                  <a class="link" href="executor/on_work_started.html" title="executor::on_work_started"><span class="bold"><strong>on_work_started</strong></span></a>
167                </p>
168              </td>
169<td>
170                <p>
171                  Inform the executor that it has some outstanding work to do.
172                </p>
173              </td>
174</tr>
175<tr>
176<td>
177                <p>
178                  <a class="link" href="executor/operator_unspecified_bool_type.html" title="executor::operator unspecified_bool_type"><span class="bold"><strong>operator unspecified_bool_type</strong></span></a>
179                </p>
180              </td>
181<td>
182                <p>
183                  Operator to test if the executor contains a valid target.
184                </p>
185              </td>
186</tr>
187<tr>
188<td>
189                <p>
190                  <a class="link" href="executor/operator_eq_.html" title="executor::operator="><span class="bold"><strong>operator=</strong></span></a>
191                </p>
192              </td>
193<td>
194                <p>
195                  Assignment operator. <br> <span class="silver"> —</span><br>
196                </p>
197                <p>
198                  <br> <span class="silver"> —</span><br> Assignment operator for nullptr_t. <br> <span class="silver"> —</span><br>
199                  Assignment operator to create a polymorphic wrapper for the specified
200                  executor.
201                </p>
202              </td>
203</tr>
204<tr>
205<td>
206                <p>
207                  <a class="link" href="executor/post.html" title="executor::post"><span class="bold"><strong>post</strong></span></a>
208                </p>
209              </td>
210<td>
211                <p>
212                  Request the executor to invoke the given function object.
213                </p>
214              </td>
215</tr>
216<tr>
217<td>
218                <p>
219                  <a class="link" href="executor/target.html" title="executor::target"><span class="bold"><strong>target</strong></span></a>
220                </p>
221              </td>
222<td>
223                <p>
224                  Obtain a pointer to the target executor object.
225                </p>
226              </td>
227</tr>
228<tr>
229<td>
230                <p>
231                  <a class="link" href="executor/target_type.html" title="executor::target_type"><span class="bold"><strong>target_type</strong></span></a>
232                </p>
233              </td>
234<td>
235                <p>
236                  Obtain type information for the target executor object.
237                </p>
238              </td>
239</tr>
240<tr>
241<td>
242                <p>
243                  <a class="link" href="executor/unspecified_bool_true.html" title="executor::unspecified_bool_true"><span class="bold"><strong>unspecified_bool_true</strong></span></a> <span class="silver">[static]</span>
244                </p>
245              </td>
246<td>
247              </td>
248</tr>
249<tr>
250<td>
251                <p>
252                  <a class="link" href="executor/_executor.html" title="executor::~executor"><span class="bold"><strong>~executor</strong></span></a> <span class="silver">[destructor]</span>
253                </p>
254              </td>
255<td>
256                <p>
257                  Destructor.
258                </p>
259              </td>
260</tr>
261</tbody>
262</table></div>
263<h5>
264<a name="boost_asio.reference.executor.h2"></a>
265        <span class="phrase"><a name="boost_asio.reference.executor.friends"></a></span><a class="link" href="executor.html#boost_asio.reference.executor.friends">Friends</a>
266      </h5>
267<div class="informaltable"><table class="table">
268<colgroup>
269<col>
270<col>
271</colgroup>
272<thead><tr>
273<th>
274                <p>
275                  Name
276                </p>
277              </th>
278<th>
279                <p>
280                  Description
281                </p>
282              </th>
283</tr></thead>
284<tbody>
285<tr>
286<td>
287                <p>
288                  <a class="link" href="executor/operator_not__eq_.html" title="executor::operator!="><span class="bold"><strong>operator!=</strong></span></a>
289                </p>
290              </td>
291<td>
292                <p>
293                  Compare two executors for inequality.
294                </p>
295              </td>
296</tr>
297<tr>
298<td>
299                <p>
300                  <a class="link" href="executor/operator_eq__eq_.html" title="executor::operator=="><span class="bold"><strong>operator==</strong></span></a>
301                </p>
302              </td>
303<td>
304                <p>
305                  Compare two executors for equality.
306                </p>
307              </td>
308</tr>
309</tbody>
310</table></div>
311<h5>
312<a name="boost_asio.reference.executor.h3"></a>
313        <span class="phrase"><a name="boost_asio.reference.executor.requirements"></a></span><a class="link" href="executor.html#boost_asio.reference.executor.requirements">Requirements</a>
314      </h5>
315<p>
316        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/executor.hpp</code>
317      </p>
318<p>
319        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
320      </p>
321</div>
322<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
323<td align="left"></td>
324<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
325      Kohlhoff<p>
326        Distributed under the Boost Software License, Version 1.0. (See accompanying
327        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>)
328      </p>
329</div></td>
330</tr></table>
331<hr>
332<div class="spirit-nav">
333<a accesskey="p" href="execution_context__service/shutdown.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="executor/context.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
334</div>
335</body>
336</html>
337