• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>execution::blocking_t</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__blocking_adaptation_t__disallowed_t/value.html" title="execution::blocking_adaptation_t::disallowed_t::value">
10<link rel="next" href="execution__blocking_t/always.html" title="execution::blocking_t::always">
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__blocking_adaptation_t__disallowed_t/value.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="execution__blocking_t/always.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.execution__blocking_t"></a><a class="link" href="execution__blocking_t.html" title="execution::blocking_t">execution::blocking_t</a>
28</h3></div></div></div>
29<p>
30        A property to describe what guarantees an executor makes about the blocking
31        behaviour of their execution functions.
32      </p>
33<pre class="programlisting">struct blocking_t
34</pre>
35<h5>
36<a name="boost_asio.reference.execution__blocking_t.h0"></a>
37        <span class="phrase"><a name="boost_asio.reference.execution__blocking_t.types"></a></span><a class="link" href="execution__blocking_t.html#boost_asio.reference.execution__blocking_t.types">Types</a>
38      </h5>
39<div class="informaltable"><table class="table">
40<colgroup>
41<col>
42<col>
43</colgroup>
44<thead><tr>
45<th>
46                <p>
47                  Name
48                </p>
49              </th>
50<th>
51                <p>
52                  Description
53                </p>
54              </th>
55</tr></thead>
56<tbody>
57<tr>
58<td>
59                <p>
60                  <a class="link" href="execution__blocking_t__always_t.html" title="execution::blocking_t::always_t"><span class="bold"><strong>always_t</strong></span></a>
61                </p>
62              </td>
63<td>
64                <p>
65                  A sub-property that indicates that invocation of an executor's
66                  execution function shall block until completion of all invocations
67                  of the submitted function object.
68                </p>
69              </td>
70</tr>
71<tr>
72<td>
73                <p>
74                  <a class="link" href="execution__blocking_t__never_t.html" title="execution::blocking_t::never_t"><span class="bold"><strong>never_t</strong></span></a>
75                </p>
76              </td>
77<td>
78                <p>
79                  A sub-property that indicates that invocation of an executor's
80                  execution function shall not block pending completion of the invocations
81                  of the submitted function object.
82                </p>
83              </td>
84</tr>
85<tr>
86<td>
87                <p>
88                  <a class="link" href="execution__blocking_t__possibly_t.html" title="execution::blocking_t::possibly_t"><span class="bold"><strong>possibly_t</strong></span></a>
89                </p>
90              </td>
91<td>
92                <p>
93                  A sub-property that indicates that invocation of an executor's
94                  execution function may block pending completion of one or more
95                  invocations of the submitted function object.
96                </p>
97              </td>
98</tr>
99<tr>
100<td>
101                <p>
102                  <a class="link" href="execution__blocking_t/polymorphic_query_result_type.html" title="execution::blocking_t::polymorphic_query_result_type"><span class="bold"><strong>polymorphic_query_result_type</strong></span></a>
103                </p>
104              </td>
105<td>
106                <p>
107                  The type returned by queries against an any_executor.
108                </p>
109              </td>
110</tr>
111</tbody>
112</table></div>
113<h5>
114<a name="boost_asio.reference.execution__blocking_t.h1"></a>
115        <span class="phrase"><a name="boost_asio.reference.execution__blocking_t.member_functions"></a></span><a class="link" href="execution__blocking_t.html#boost_asio.reference.execution__blocking_t.member_functions">Member
116        Functions</a>
117      </h5>
118<div class="informaltable"><table class="table">
119<colgroup>
120<col>
121<col>
122</colgroup>
123<thead><tr>
124<th>
125                <p>
126                  Name
127                </p>
128              </th>
129<th>
130                <p>
131                  Description
132                </p>
133              </th>
134</tr></thead>
135<tbody><tr>
136<td>
137                <p>
138                  <a class="link" href="execution__blocking_t/blocking_t.html" title="execution::blocking_t::blocking_t"><span class="bold"><strong>blocking_t</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 a sub-property
144                  value.
145                </p>
146              </td>
147</tr></tbody>
148</table></div>
149<h5>
150<a name="boost_asio.reference.execution__blocking_t.h2"></a>
151        <span class="phrase"><a name="boost_asio.reference.execution__blocking_t.data_members"></a></span><a class="link" href="execution__blocking_t.html#boost_asio.reference.execution__blocking_t.data_members">Data Members</a>
152      </h5>
153<div class="informaltable"><table class="table">
154<colgroup>
155<col>
156<col>
157</colgroup>
158<thead><tr>
159<th>
160                <p>
161                  Name
162                </p>
163              </th>
164<th>
165                <p>
166                  Description
167                </p>
168              </th>
169</tr></thead>
170<tbody>
171<tr>
172<td>
173                <p>
174                  <a class="link" href="execution__blocking_t/always.html" title="execution::blocking_t::always"><span class="bold"><strong>always</strong></span></a> <span class="silver">[static]</span>
175                </p>
176              </td>
177<td>
178                <p>
179                  A special value used for accessing the blocking_t::always_t property.
180                </p>
181              </td>
182</tr>
183<tr>
184<td>
185                <p>
186                  <a class="link" href="execution__blocking_t/is_applicable_property_v.html" title="execution::blocking_t::is_applicable_property_v"><span class="bold"><strong>is_applicable_property_v</strong></span></a> <span class="silver">[static]</span>
187                </p>
188              </td>
189<td>
190                <p>
191                  The blocking_t property applies to executors, senders, and schedulers.
192                </p>
193              </td>
194</tr>
195<tr>
196<td>
197                <p>
198                  <a class="link" href="execution__blocking_t/is_preferable.html" title="execution::blocking_t::is_preferable"><span class="bold"><strong>is_preferable</strong></span></a> <span class="silver">[static]</span>
199                </p>
200              </td>
201<td>
202                <p>
203                  The top-level blocking_t property cannot be preferred.
204                </p>
205              </td>
206</tr>
207<tr>
208<td>
209                <p>
210                  <a class="link" href="execution__blocking_t/is_requirable.html" title="execution::blocking_t::is_requirable"><span class="bold"><strong>is_requirable</strong></span></a> <span class="silver">[static]</span>
211                </p>
212              </td>
213<td>
214                <p>
215                  The top-level blocking_t property cannot be required.
216                </p>
217              </td>
218</tr>
219<tr>
220<td>
221                <p>
222                  <a class="link" href="execution__blocking_t/never.html" title="execution::blocking_t::never"><span class="bold"><strong>never</strong></span></a> <span class="silver">[static]</span>
223                </p>
224              </td>
225<td>
226                <p>
227                  A special value used for accessing the blocking_t::never_t property.
228                </p>
229              </td>
230</tr>
231<tr>
232<td>
233                <p>
234                  <a class="link" href="execution__blocking_t/possibly.html" title="execution::blocking_t::possibly"><span class="bold"><strong>possibly</strong></span></a> <span class="silver">[static]</span>
235                </p>
236              </td>
237<td>
238                <p>
239                  A special value used for accessing the blocking_t::possibly_t property.
240                </p>
241              </td>
242</tr>
243</tbody>
244</table></div>
245<h5>
246<a name="boost_asio.reference.execution__blocking_t.h3"></a>
247        <span class="phrase"><a name="boost_asio.reference.execution__blocking_t.friends"></a></span><a class="link" href="execution__blocking_t.html#boost_asio.reference.execution__blocking_t.friends">Friends</a>
248      </h5>
249<div class="informaltable"><table class="table">
250<colgroup>
251<col>
252<col>
253</colgroup>
254<thead><tr>
255<th>
256                <p>
257                  Name
258                </p>
259              </th>
260<th>
261                <p>
262                  Description
263                </p>
264              </th>
265</tr></thead>
266<tbody>
267<tr>
268<td>
269                <p>
270                  <a class="link" href="execution__blocking_t/operator_not__eq_.html" title="execution::blocking_t::operator!="><span class="bold"><strong>operator!=</strong></span></a>
271                </p>
272              </td>
273<td>
274                <p>
275                  Compare property values for inequality.
276                </p>
277              </td>
278</tr>
279<tr>
280<td>
281                <p>
282                  <a class="link" href="execution__blocking_t/operator_eq__eq_.html" title="execution::blocking_t::operator=="><span class="bold"><strong>operator==</strong></span></a>
283                </p>
284              </td>
285<td>
286                <p>
287                  Compare property values for equality.
288                </p>
289              </td>
290</tr>
291</tbody>
292</table></div>
293<h5>
294<a name="boost_asio.reference.execution__blocking_t.h4"></a>
295        <span class="phrase"><a name="boost_asio.reference.execution__blocking_t.requirements"></a></span><a class="link" href="execution__blocking_t.html#boost_asio.reference.execution__blocking_t.requirements">Requirements</a>
296      </h5>
297<p>
298        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/execution/blocking.hpp</code>
299      </p>
300<p>
301        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio/execution.hpp</code>
302      </p>
303</div>
304<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
305<td align="left"></td>
306<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
307      Kohlhoff<p>
308        Distributed under the Boost Software License, Version 1.0. (See accompanying
309        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>)
310      </p>
311</div></td>
312</tr></table>
313<hr>
314<div class="spirit-nav">
315<a accesskey="p" href="execution__blocking_adaptation_t__disallowed_t/value.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="execution__blocking_t/always.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
316</div>
317</body>
318</html>
319