executor_work_guard.html
6.79 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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>executor_work_guard</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="executor_binder/_executor_binder.html" title="executor_binder::~executor_binder">
<link rel="next" href="executor_work_guard/executor_type.html" title="executor_work_guard::executor_type">
</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="executor_binder/_executor_binder.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="executor_work_guard/executor_type.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.executor_work_guard"></a><a class="link" href="executor_work_guard.html" title="executor_work_guard">executor_work_guard</a>
</h3></div></div></div>
<p>
An object of type <code class="computeroutput">executor_work_guard</code> controls ownership of
executor work within a scope.
</p>
<pre class="programlisting">template<
typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>>
class executor_work_guard
</pre>
<h5>
<a name="asio.reference.executor_work_guard.h0"></a>
<span><a name="asio.reference.executor_work_guard.types"></a></span><a class="link" href="executor_work_guard.html#asio.reference.executor_work_guard.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="executor_work_guard/executor_type.html" title="executor_work_guard::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
</p>
</td>
<td>
<p>
The underlying executor type.
</p>
</td>
</tr></tbody>
</table></div>
<h5>
<a name="asio.reference.executor_work_guard.h1"></a>
<span><a name="asio.reference.executor_work_guard.member_functions"></a></span><a class="link" href="executor_work_guard.html#asio.reference.executor_work_guard.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="executor_work_guard/executor_work_guard.html" title="executor_work_guard::executor_work_guard"><span class="bold"><strong>executor_work_guard</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Constructs a executor_work_guard object for the specified executor.
<br> <span class="silver"> —</span><br> Copy constructor. <br> <span class="silver"> —</span><br> Move constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="executor_work_guard/get_executor.html" title="executor_work_guard::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
</p>
</td>
<td>
<p>
Obtain the associated executor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="executor_work_guard/owns_work.html" title="executor_work_guard::owns_work"><span class="bold"><strong>owns_work</strong></span></a>
</p>
</td>
<td>
<p>
Whether the executor_work_guard object owns some outstanding work.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="executor_work_guard/reset.html" title="executor_work_guard::reset"><span class="bold"><strong>reset</strong></span></a>
</p>
</td>
<td>
<p>
Indicate that the work is no longer outstanding.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="executor_work_guard/_executor_work_guard.html" title="executor_work_guard::~executor_work_guard"><span class="bold"><strong>~executor_work_guard</strong></span></a> <span class="silver">[destructor]</span>
</p>
</td>
<td>
<p>
Destructor.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.executor_work_guard.h2"></a>
<span><a name="asio.reference.executor_work_guard.requirements"></a></span><a class="link" href="executor_work_guard.html#asio.reference.executor_work_guard.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/executor_work_guard.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="executor_binder/_executor_binder.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="executor_work_guard/executor_type.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>