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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>spawn</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="socket_base/_socket_base.html" title="socket_base::~socket_base">
<link rel="next" href="spawn/overload1.html" title="spawn (1 of 7 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="socket_base/_socket_base.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="spawn/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.spawn"></a><a class="link" href="spawn.html" title="spawn">spawn</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.spawn"></a>
Start a new stackful coroutine.
</p>
<p>
Start a new stackful coroutine, calling the specified handler when it completes.
</p>
<pre class="programlisting">template<
typename Function>
void <a class="link" href="spawn/overload1.html" title="spawn (1 of 7 overloads)">spawn</a>(
Function && function,
const boost::coroutines::attributes & attributes = boost::coroutines::attributes());
<span class="emphasis"><em>» <a class="link" href="spawn/overload1.html" title="spawn (1 of 7 overloads)">more...</a></em></span>
template<
typename <a class="link" href="Handler.html" title="Handlers">Handler</a>,
typename Function>
void <a class="link" href="spawn/overload2.html" title="spawn (2 of 7 overloads)">spawn</a>(
Handler && handler,
Function && function,
const boost::coroutines::attributes & attributes = boost::coroutines::attributes(),
typename enable_if<!is_executor< typename decay< Handler >::type >::value &&!is_convertible< Handler &, execution_context & >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="spawn/overload2.html" title="spawn (2 of 7 overloads)">more...</a></em></span>
</pre>
<p>
Start a new stackful coroutine, inheriting the execution context of another.
</p>
<pre class="programlisting">template<
typename <a class="link" href="Handler.html" title="Handlers">Handler</a>,
typename Function>
void <a class="link" href="spawn/overload3.html" title="spawn (3 of 7 overloads)">spawn</a>(
basic_yield_context< Handler > ctx,
Function && function,
const boost::coroutines::attributes & attributes = boost::coroutines::attributes());
<span class="emphasis"><em>» <a class="link" href="spawn/overload3.html" title="spawn (3 of 7 overloads)">more...</a></em></span>
</pre>
<p>
Start a new stackful coroutine that executes on a given executor.
</p>
<pre class="programlisting">template<
typename Function,
typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>>
void <a class="link" href="spawn/overload4.html" title="spawn (4 of 7 overloads)">spawn</a>(
const Executor & ex,
Function && function,
const boost::coroutines::attributes & attributes = boost::coroutines::attributes(),
typename enable_if< is_executor< Executor >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="spawn/overload4.html" title="spawn (4 of 7 overloads)">more...</a></em></span>
</pre>
<p>
Start a new stackful coroutine that executes on a given strand.
</p>
<pre class="programlisting">template<
typename Function,
typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>>
void <a class="link" href="spawn/overload5.html" title="spawn (5 of 7 overloads)">spawn</a>(
const strand< Executor > & ex,
Function && function,
const boost::coroutines::attributes & attributes = boost::coroutines::attributes());
<span class="emphasis"><em>» <a class="link" href="spawn/overload5.html" title="spawn (5 of 7 overloads)">more...</a></em></span>
</pre>
<p>
Start a new stackful coroutine that executes in the context of a strand.
</p>
<pre class="programlisting">template<
typename Function>
void <a class="link" href="spawn/overload6.html" title="spawn (6 of 7 overloads)">spawn</a>(
const boost::asio::io_context::strand & s,
Function && function,
const boost::coroutines::attributes & attributes = boost::coroutines::attributes());
<span class="emphasis"><em>» <a class="link" href="spawn/overload6.html" title="spawn (6 of 7 overloads)">more...</a></em></span>
</pre>
<p>
Start a new stackful coroutine that executes on a given execution context.
</p>
<pre class="programlisting">template<
typename Function,
typename ExecutionContext>
void <a class="link" href="spawn/overload7.html" title="spawn (7 of 7 overloads)">spawn</a>(
ExecutionContext & ctx,
Function && function,
const boost::coroutines::attributes & attributes = boost::coroutines::attributes(),
typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="spawn/overload7.html" title="spawn (7 of 7 overloads)">more...</a></em></span>
</pre>
<p>
The <code class="computeroutput">spawn()</code> function is a high-level wrapper over the Boost.Coroutine
library. This function enables programs to implement asynchronous logic in
a synchronous manner, as illustrated by the following example:
</p>
<pre class="programlisting">boost::asio::spawn(my_strand, do_echo);
// ...
void do_echo(boost::asio::yield_context yield)
{
try
{
char data[128];
for (;;)
{
std::size_t length =
my_socket.async_read_some(
boost::asio::buffer(data), yield);
boost::asio::async_write(my_socket,
boost::asio::buffer(data, length), yield);
}
}
catch (std::exception& e)
{
// ...
}
}
</pre>
<h5>
<a name="boost_asio.reference.spawn.h0"></a>
<span class="phrase"><a name="boost_asio.reference.spawn.requirements"></a></span><a class="link" href="spawn.html#boost_asio.reference.spawn.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/spawn.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span>None
</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-2018 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="socket_base/_socket_base.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="spawn/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
