summaryrefslogtreecommitdiff
path: root/doc/html/boost/process/on_exit.html
blob: 07bda8dae721e43a813a302731b1155f511a8654 (plain)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Global on_exit</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="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../process/reference.html#header.boost.process.async_hpp" title="Header &lt;boost/process/async.hpp&gt;">
<link rel="prev" href="argv.html" title="Global argv">
<link rel="next" href="async_pipe.html" title="Class async_pipe">
</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="argv.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.async_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_pipe.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.process.on_exit"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Global on_exit</span></h2>
<p>boost::process::on_exit</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../process/reference.html#header.boost.process.async_hpp" title="Header &lt;boost/process/async.hpp&gt;">boost/process/async.hpp</a>&gt;

</span><span class="keyword">static</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> on_exit<span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp429212512"></a><h2>Description</h2>
<p>When an io_service is passed, the on_exit property can be used, to be notified when the child process exits.</p>
<p>The following syntax is valid</p>
<pre class="programlisting"><span class="identifier">on_exit</span><span class="special">=</span><span class="identifier">function</span><span class="special">;</span>
<span class="identifier">on_exit</span><span class="special">(</span><span class="identifier">function</span><span class="special">)</span><span class="special">;</span>
</pre>
<p>with <code class="computeroutput">function</code> being a callable object with the signature <code class="computeroutput">(int, const std::error_code&amp;)</code> or an <code class="computeroutput">std::future&lt;int&gt;</code>.</p>
<p><b>Example.&#160;</b></p>
<p>
</p>
<pre class="programlisting"><span class="identifier">io_service</span> <span class="identifier">ios</span><span class="special">;</span>

<span class="identifier">child</span> <span class="identifier">c</span><span class="special">(</span><span class="string">"ls"</span><span class="special">,</span> <span class="identifier">on_exit</span><span class="special">=</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">exit</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec_in</span><span class="special">)</span><span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>

<span class="identifier">std</span><span class="special">::</span><span class="identifier">future</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">exit_code</span><span class="special">;</span>
<span class="identifier">chlid</span> <span class="identifier">c2</span><span class="special">(</span><span class="string">"ls"</span><span class="special">,</span> <span class="identifier">on_exit</span><span class="special">=</span><span class="identifier">exit_code</span><span class="special">)</span><span class="special">;</span>
</pre>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>The handler is not invoked when the launch fails. </p></td></tr>
</table></div>
<p>
</p>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>When used ignore_error it might gte invoked on error. </p></td></tr>
</table></div>
<p>
</p>
</div>
</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 &#169; 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
      Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright &#169; 2016 Klemens D. Morgenstern<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="argv.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.async_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_pipe.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>