execution_context.html
16.5 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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>execution_context</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="execution__submit.html" title="execution::submit">
<link rel="next" href="execution_context/add_service.html" title="execution_context::add_service">
</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="execution__submit.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="execution_context/add_service.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.execution_context"></a><a class="link" href="execution_context.html" title="execution_context">execution_context</a>
</h3></div></div></div>
<p>
A context for function object execution.
</p>
<pre class="programlisting">class execution_context :
noncopyable
</pre>
<h5>
<a name="asio.reference.execution_context.h0"></a>
<span><a name="asio.reference.execution_context.types"></a></span><a class="link" href="execution_context.html#asio.reference.execution_context.types">Types</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="execution_context__id.html" title="execution_context::id"><span class="bold"><strong>id</strong></span></a>
</p>
</td>
<td>
<p>
Class used to uniquely identify a service.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="execution_context__service.html" title="execution_context::service"><span class="bold"><strong>service</strong></span></a>
</p>
</td>
<td>
<p>
Base class for all io_context services.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="execution_context/fork_event.html" title="execution_context::fork_event"><span class="bold"><strong>fork_event</strong></span></a>
</p>
</td>
<td>
<p>
Fork-related event notifications.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.execution_context.h1"></a>
<span><a name="asio.reference.execution_context.member_functions"></a></span><a class="link" href="execution_context.html#asio.reference.execution_context.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="execution_context/execution_context.html" title="execution_context::execution_context"><span class="bold"><strong>execution_context</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="execution_context/notify_fork.html" title="execution_context::notify_fork"><span class="bold"><strong>notify_fork</strong></span></a>
</p>
</td>
<td>
<p>
Notify the execution_context of a fork-related event.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="execution_context/_execution_context.html" title="execution_context::~execution_context"><span class="bold"><strong>~execution_context</strong></span></a> <span class="silver">[destructor]</span>
</p>
</td>
<td>
<p>
Destructor.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.execution_context.h2"></a>
<span><a name="asio.reference.execution_context.protected_member_functions"></a></span><a class="link" href="execution_context.html#asio.reference.execution_context.protected_member_functions">Protected
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="execution_context/destroy.html" title="execution_context::destroy"><span class="bold"><strong>destroy</strong></span></a>
</p>
</td>
<td>
<p>
Destroys all services in the context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="execution_context/shutdown.html" title="execution_context::shutdown"><span class="bold"><strong>shutdown</strong></span></a>
</p>
</td>
<td>
<p>
Shuts down all services in the context.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.execution_context.h3"></a>
<span><a name="asio.reference.execution_context.friends"></a></span><a class="link" href="execution_context.html#asio.reference.execution_context.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="execution_context/add_service.html" title="execution_context::add_service"><span class="bold"><strong>add_service</strong></span></a>
</p>
</td>
<td>
<p>
(Deprecated: Use make_service().) Add a service object to the execution_context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="execution_context/has_service.html" title="execution_context::has_service"><span class="bold"><strong>has_service</strong></span></a>
</p>
</td>
<td>
<p>
Determine if an execution_context contains a specified service
type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="execution_context/make_service.html" title="execution_context::make_service"><span class="bold"><strong>make_service</strong></span></a>
</p>
</td>
<td>
<p>
Creates a service object and adds it to the execution_context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="execution_context/use_service.html" title="execution_context::use_service"><span class="bold"><strong>use_service</strong></span></a>
</p>
</td>
<td>
<p>
Obtain the service object corresponding to the given type.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
An execution context represents a place where function objects will be executed.
An <code class="computeroutput">io_context</code> is an example of an execution context.
</p>
<h5>
<a name="asio.reference.execution_context.h4"></a>
<span><a name="asio.reference.execution_context.the_execution_context_class_and_services"></a></span><a class="link" href="execution_context.html#asio.reference.execution_context.the_execution_context_class_and_services">The
execution_context class and services</a>
</h5>
<p>
Class <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
implements an extensible, type-safe, polymorphic set of services, indexed
by service type.
</p>
<p>
Services exist to manage the resources that are shared across an execution
context. For example, timers may be implemented in terms of a single timer
queue, and this queue would be stored in a service.
</p>
<p>
Access to the services of an <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
is via three function templates, <code class="computeroutput">use_service()</code>, <code class="computeroutput">add_service()</code>
and <code class="computeroutput">has_service()</code>.
</p>
<p>
In a call to <code class="computeroutput">use_service<Service>()</code>, the type argument
chooses a service, making available all members of the named type. If <code class="computeroutput">Service</code>
is not present in an <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>,
an object of type <code class="computeroutput">Service</code> is created and added to the <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>.
A C++ program can check if an <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
implements a particular service with the function template <code class="computeroutput">has_service<Service>()</code>.
</p>
<p>
Service objects may be explicitly added to an <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
using the function template <code class="computeroutput">add_service<Service>()</code>. If
the <code class="computeroutput">Service</code> is already present, the <a class="link" href="service_already_exists.html" title="service_already_exists"><code class="computeroutput">service_already_exists</code></a>
exception is thrown. If the owner of the service is not the same object as
the <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
parameter, the <a class="link" href="invalid_service_owner.html" title="invalid_service_owner"><code class="computeroutput">invalid_service_owner</code></a>
exception is thrown.
</p>
<p>
Once a service reference is obtained from an <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
object by calling <code class="computeroutput">use_service()</code>, that reference remains usable
as long as the owning <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
object exists.
</p>
<p>
All service implementations have <a class="link" href="execution_context__service.html" title="execution_context::service"><code class="computeroutput">execution_context::service</code></a>
as a public base class. Custom services may be implemented by deriving from
this class and then added to an <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
using the facilities described above.
</p>
<h5>
<a name="asio.reference.execution_context.h5"></a>
<span><a name="asio.reference.execution_context.the_execution_context_as_a_base_class"></a></span><a class="link" href="execution_context.html#asio.reference.execution_context.the_execution_context_as_a_base_class">The
execution_context as a base class</a>
</h5>
<p>
Class <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
may be used only as a base class for concrete execution context types. The
<code class="computeroutput">io_context</code> is an example of such a derived type.
</p>
<p>
On destruction, a class that is derived from <a class="link" href="execution_context.html" title="execution_context"><code class="computeroutput">execution_context</code></a>
must perform <code class="computeroutput">execution_context::shutdown()</code> followed by <code class="computeroutput">execution_context::destroy()</code>.
</p>
<p>
This destruction sequence permits programs to simplify their resource management
by using <code class="computeroutput">shared_ptr<></code>. Where an object's lifetime is tied
to the lifetime of a connection (or some other sequence of asynchronous operations),
a <code class="computeroutput">shared_ptr</code> to the object would be bound into the handlers
for all asynchronous operations associated with it. This works as follows:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
When a single connection ends, all associated asynchronous operations
complete. The corresponding handler objects are destroyed, and all <code class="computeroutput">shared_ptr</code>
references to the objects are destroyed.
</li>
<li class="listitem">
To shut down the whole program, the <a class="link" href="io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
function stop() is called to terminate any run() calls as soon as possible.
The <a class="link" href="io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
destructor calls <code class="computeroutput">shutdown()</code> and <code class="computeroutput">destroy()</code> to
destroy all pending handlers, causing all <code class="computeroutput">shared_ptr</code> references
to all connection objects to be destroyed.
</li>
</ul></div>
<h5>
<a name="asio.reference.execution_context.h6"></a>
<span><a name="asio.reference.execution_context.requirements"></a></span><a class="link" href="execution_context.html#asio.reference.execution_context.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/execution_context.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio/execution.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="execution__submit.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="execution_context/add_service.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>