basic_system_executor.html
10.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_system_executor</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="basic_streambuf_ref/size.html" title="basic_streambuf_ref::size">
<link rel="next" href="basic_system_executor/basic_system_executor.html" title="basic_system_executor::basic_system_executor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_streambuf_ref/size.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="basic_system_executor/basic_system_executor.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.basic_system_executor"></a><a class="link" href="basic_system_executor.html" title="basic_system_executor">basic_system_executor</a>
</h3></div></div></div>
<p>
An executor that uses arbitrary threads.
</p>
<pre class="programlisting">template<
typename Blocking,
typename Relationship,
typename Allocator>
class basic_system_executor
</pre>
<h5>
<a name="asio.reference.basic_system_executor.h0"></a>
<span><a name="asio.reference.basic_system_executor.member_functions"></a></span><a class="link" href="basic_system_executor.html#asio.reference.basic_system_executor.member_functions">Member Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Default constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_system_executor/context.html" title="basic_system_executor::context"><span class="bold"><strong>context</strong></span></a>
</p>
</td>
<td>
<p>
Obtain the underlying execution context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_system_executor/defer.html" title="basic_system_executor::defer"><span class="bold"><strong>defer</strong></span></a>
</p>
</td>
<td>
<p>
Request the system executor to invoke the given function object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_system_executor/dispatch.html" title="basic_system_executor::dispatch"><span class="bold"><strong>dispatch</strong></span></a>
</p>
</td>
<td>
<p>
Request the system executor to invoke the given function object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_system_executor/execute.html" title="basic_system_executor::execute"><span class="bold"><strong>execute</strong></span></a>
</p>
</td>
<td>
<p>
Execution function.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Inform the executor that some work is no longer outstanding.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Inform the executor that it has some outstanding work to do.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_system_executor/post.html" title="basic_system_executor::post"><span class="bold"><strong>post</strong></span></a>
</p>
</td>
<td>
<p>
Request the system executor to invoke the given function object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_system_executor/query.html" title="basic_system_executor::query"><span class="bold"><strong>query</strong></span></a>
</p>
</td>
<td>
<p>
Query the current value of the allocator property. <br> <span class="silver"> —</span><br>
Query the occupancy (recommended number of work items) for the
system context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Query the current value of the mapping property. <br> <span class="silver"> —</span><br>
Query the current value of the context property. <br> <span class="silver"> —</span><br>
Query the current value of the blocking property. <br> <span class="silver"> —</span><br>
Query the current value of the relationship property.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_system_executor/require.html" title="basic_system_executor::require"><span class="bold"><strong>require</strong></span></a>
</p>
</td>
<td>
<p>
Obtain an executor with the blocking.possibly property. <br>
<span class="silver"> —</span><br> Obtain an executor with the blocking.always property. <br>
<span class="silver"> —</span><br> Obtain an executor with the blocking.never property. <br>
<span class="silver"> —</span><br> Obtain an executor with the relationship.continuation property.
<br> <span class="silver"> —</span><br> Obtain an executor with the relationship.fork property.
<br> <span class="silver"> —</span><br> Obtain an executor with the specified allocator property.
<br> <span class="silver"> —</span><br> Obtain an executor with the default allocator property.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.basic_system_executor.h1"></a>
<span><a name="asio.reference.basic_system_executor.friends"></a></span><a class="link" href="basic_system_executor.html#asio.reference.basic_system_executor.friends">Friends</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="basic_system_executor/operator_not__eq_.html" title="basic_system_executor::operator!="><span class="bold"><strong>operator!=</strong></span></a>
</p>
</td>
<td>
<p>
Compare two executors for inequality.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_system_executor/operator_eq__eq_.html" title="basic_system_executor::operator=="><span class="bold"><strong>operator==</strong></span></a>
</p>
</td>
<td>
<p>
Compare two executors for equality.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
The system executor represents an execution context where functions are permitted
to run on arbitrary threads. When the blocking.never property is established,
the system executor will schedule the function to run on an unspecified system
thread pool. When either blocking.possibly or blocking.always is established,
the executor invokes the function immediately.
</p>
<h5>
<a name="asio.reference.basic_system_executor.h2"></a>
<span><a name="asio.reference.basic_system_executor.requirements"></a></span><a class="link" href="basic_system_executor.html#asio.reference.basic_system_executor.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/system_executor.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_streambuf_ref/size.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="basic_system_executor/basic_system_executor.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>