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