blob: 7cc6f0f0da765069ce4a07e0128622e1cef09d4e (
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
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
176
|
<!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>Chapter 29. Boost.Process</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="libraries.html" title="Part I. The Boost C++ Libraries (BoostBook Subset)">
<link rel="prev" href="predef/acknoledgements.html" title="Acknoledgements">
<link rel="next" href="boost_process/concepts.html" title="Concepts">
</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="predef/acknoledgements.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><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="boost_process/concepts.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="chapter">
<div class="titlepage"><div>
<div><h2 class="title">
<a name="process"></a>Chapter 29. Boost.Process</h2></div>
<div><div class="author"><h3 class="author">
<span class="firstname">Klemens David</span> <span class="surname">Morgenstern</span>
</h3></div></div>
<div><p class="copyright">Copyright © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
Felipe Tanus, Jeff Flinn, Boris Schaeling</p></div>
<div><p class="copyright">Copyright © 2016 Klemens D. Morgenstern</p></div>
<div><div class="legalnotice">
<a name="process.legal"></a><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></div>
</div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl class="toc">
<dt><span class="section"><a href="process.html#boost_process.introduction">Introduction</a></span></dt>
<dt><span class="section"><a href="boost_process/concepts.html">Concepts</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_process/concepts.html#boost_process.concepts.pipes">Pipes</a></span></dt>
<dt><span class="section"><a href="boost_process/concepts.html#boost_process.concepts.process">Processes</a></span></dt>
<dt><span class="section"><a href="boost_process/concepts.html#boost_process.concepts.env">Environment</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_process/tutorial.html">Tutorial</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_process/tutorial.html#boost_process.tutorial.starting_a_process">Starting a
process</a></span></dt>
<dt><span class="section"><a href="boost_process/tutorial.html#boost_process.tutorial.launch_mode">Launch functions</a></span></dt>
<dt><span class="section"><a href="boost_process/tutorial.html#boost_process.tutorial.error_handling">Error</a></span></dt>
<dt><span class="section"><a href="boost_process/tutorial.html#boost_process.tutorial.io">Synchronous I/O</a></span></dt>
<dt><span class="section"><a href="boost_process/tutorial.html#boost_process.tutorial.async_io">Asynchronous I/O</a></span></dt>
<dt><span class="section"><a href="boost_process/tutorial.html#boost_process.tutorial.group">Groups</a></span></dt>
<dt><span class="section"><a href="boost_process/tutorial.html#boost_process.tutorial.env">Environment</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_process/design.html">Design Rationale</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_process/design.html#boost_process.design.scope">Scope</a></span></dt>
<dt><span class="section"><a href="boost_process/design.html#boost_process.design.interface_style">Interface Style</a></span></dt>
<dt><span class="section"><a href="boost_process/design.html#boost_process.design.arg_cmd_style">Arguments/Command
Style</a></span></dt>
<dt><span class="section"><a href="boost_process/design.html#boost_process.design.plat_ext">Extensions</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_process/extend.html">Extensions</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_process/extend.html#boost_process.extend.structure">Structure</a></span></dt>
<dt><span class="section"><a href="boost_process/extend.html#boost_process.extend.simple">Simple extensions</a></span></dt>
<dt><span class="section"><a href="boost_process/extend.html#boost_process.extend.handler">Handler Types</a></span></dt>
<dt><span class="section"><a href="boost_process/extend.html#boost_process.extend.async">Asynchronous Functionality</a></span></dt>
<dt><span class="section"><a href="boost_process/extend.html#boost_process.extend.error">Error handling</a></span></dt>
<dt><span class="section"><a href="boost_process/extend.html#boost_process.extend.exec_over">Executor Overloading</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_process/faq.html">Frequently Asked Questions</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_process/faq.html#boost_process.faq.dead_lock">Why does this produce a
deadlock?</a></span></dt>
<dt><span class="section"><a href="boost_process/faq.html#boost_process.faq.closep">Why does the pipe not close?</a></span></dt>
<dt><span class="section"><a href="boost_process/faq.html#boost_process.faq.wchar_t">When will the codecvt be used?</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="process/reference.html">Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="process/reference.html#header.boost.process.args_hpp">Header <boost/process/args.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.async_hpp">Header <boost/process/async.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.async_pipe_hpp">Header <boost/process/async_pipe.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.async_system_hpp">Header <boost/process/async_system.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.child_hpp">Header <boost/process/child.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.cmd_hpp">Header <boost/process/cmd.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.env_hpp">Header <boost/process/env.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.environment_hpp">Header <boost/process/environment.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.error_hpp">Header <boost/process/error.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.exception_hpp">Header <boost/process/exception.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.exe_hpp">Header <boost/process/exe.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.extend_hpp">Header <boost/process/extend.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.group_hpp">Header <boost/process/group.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.io_hpp">Header <boost/process/io.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.locale_hpp">Header <boost/process/locale.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.pipe_hpp">Header <boost/process/pipe.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.posix_hpp">Header <boost/process/posix.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.search_path_hpp">Header <boost/process/search_path.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.shell_hpp">Header <boost/process/shell.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.spawn_hpp">Header <boost/process/spawn.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.start_dir_hpp">Header <boost/process/start_dir.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.system_hpp">Header <boost/process/system.hpp></a></span></dt>
<dt><span class="section"><a href="process/reference.html#header.boost.process.windows_hpp">Header <boost/process/windows.hpp></a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_process/acknowledgements.html">Acknowledgements</a></span></dt>
</dl>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_process.introduction"></a><a class="link" href="process.html#boost_process.introduction" title="Introduction">Introduction</a>
</h2></div></div></div>
<p>
Boost.Process is a library to manage system processes. It can be used to:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
create child processes
</li>
<li class="listitem">
setup streams for child processes
</li>
<li class="listitem">
communicate with child processes through streams (synchronously or asynchronously)
</li>
<li class="listitem">
wait for processes to exit (synchronously or asynchronously)
</li>
<li class="listitem">
terminate processes
</li>
</ul></div>
<p>
Here's a simple example of how to start a program with Boost.Process:
</p>
<p>
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><code class="computeroutput">boost/process.hpp</code><span class="special">></span>
<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">process</span><span class="special">;</span>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<code class="computeroutput"><a class="link" href="process/reference.html#boost.process.ipstream">ipstream</a></code> <span class="identifier">pipe_stream</span><span class="special">;</span>
<code class="computeroutput">child</code> <span class="identifier">c</span><span class="special">(</span><span class="string">"gcc --version"</span><span class="special">,</span> <code class="computeroutput"><a class="link" href="boost/process/std_out.html" title="Global std_out">std_out</a></code> <span class="special">></span> <span class="identifier">pipe_stream</span><span class="special">);</span>
<a href="http://en.cppreference.com/w/cpp/string/basic_string" target="_top">std::string</a> <span class="identifier">line</span><span class="special">;</span>
<span class="keyword">while</span> <span class="special">(</span><span class="identifier">pipe_stream</span> <span class="special">&&</span> <a href="http://en.cppreference.com/w/cpp/string/basic_string/getline" target="_top">std::getline</a><span class="special">(</span><span class="identifier">pipe_stream</span><span class="special">,</span> <span class="identifier">line</span><span class="special">)</span> <span class="special">&&</span> <span class="special">!</span><span class="identifier">line</span><span class="special">.</span><span class="identifier">empty</span><span class="special">())</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cerr</span> <span class="special"><<</span> <span class="identifier">line</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">c</span><span class="special">.</span><span class="identifier">wait</span><span class="special">();</span>
<span class="special">}</span>
</pre>
<p>
</p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: April 17, 2017 at 02:30:54 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="predef/acknoledgements.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><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="boost_process/concepts.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
