diff options
Diffstat (limited to 'doc/html/boost/process')
60 files changed, 6268 insertions, 0 deletions
diff --git a/doc/html/boost/process/args.html b/doc/html/boost/process/args.html new file mode 100644 index 0000000000..a25c6cd00e --- /dev/null +++ b/doc/html/boost/process/args.html @@ -0,0 +1,143 @@ +<!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 args</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.args_hpp" title="Header <boost/process/args.hpp>"> +<link rel="prev" href="../../process/reference.html" title="Reference"> +<link rel="next" href="argv.html" title="Global argv"> +</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="../../process/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.args_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="argv.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.args"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global args</span></h2> +<p>boost::process::args</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: <<a class="link" href="../../process/reference.html#header.boost.process.args_hpp" title="Header <boost/process/args.hpp>">boost/process/args.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> args<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp431800256"></a><h2>Description</h2> +<p>The <code class="computeroutput">args</code> property allows to explicitly set arguments for the execution. The name of the executable will always be the first element in the arg-vector.</p> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="namespaceboost_1_1process_1args_details"></a>Details</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt><span class="sect2"><a href="args.html#namespaceboost_1_1process_1args_operations">Operations</a></span></dt> +<dt><span class="sect2"><a href="args.html#namespaceboost_1_1process_1args_example">Example</a></span></dt> +</dl></div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1args_operations"></a>Operations</h3></div></div></div> +<div class="toc"><dl class="toc"> +<dt><span class="sect3"><a href="args.html#namespaceboost_1_1process_1args_set_var">Setting values</a></span></dt> +<dt><span class="sect3"><a href="args.html#namespaceboost_1_1process_1args_append_var">Appending values</a></span></dt> +</dl></div> +<div class="sect3"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="namespaceboost_1_1process_1args_set_var"></a>Setting values</h4></div></div></div> +<div class="toc"><dl class="toc"><dt><span class="sect4"><a href="args.html#namespaceboost_1_1process_1args_set_var_value">value</a></span></dt></dl></div> +<p>To set a the argument vector the following syntax can be used.</p> +<pre class="programlisting"><span class="identifier">args</span> <span class="special">=</span> <span class="identifier">value</span><span class="special">;</span> +<span class="identifier">args</span><span class="special">(</span><span class="identifier">value</span><span class="special">)</span><span class="special">;</span> +</pre> +<p><code class="computeroutput">std::initializer_list</code> is among the allowed types, so the following syntax is also possible.</p> +<pre class="programlisting"><span class="identifier">args</span> <span class="special">=</span> <span class="special">{</span><span class="identifier">value1</span><span class="special">,</span> <span class="identifier">value2</span><span class="special">}</span><span class="special">;</span> +<span class="identifier">args</span><span class="special">(</span><span class="special">{</span><span class="identifier">value1</span><span class="special">,</span> <span class="identifier">value2</span><span class="special">}</span><span class="special">)</span><span class="special">;</span> +</pre> +<p>Below the possible types for <code class="computeroutput">value</code> are listed, with <code class="computeroutput">char_type</code> being either <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>.</p> +<div class="sect4"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="namespaceboost_1_1process_1args_set_var_value"></a>value</h5></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type *</code></p></li> +<li class="listitem"><p><code class="computeroutput">std::initializer_list<const char_type *></code></p></li> +<li class="listitem"><p><code class="computeroutput">std::vector<std::basic_string<char_type>></code></p></li> +</ul></div> +<p> +</p> +<p>Additionally any range of <code class="computeroutput">std::basic_string<char_type></code> can be passed.</p> +</div> +</div> +<div class="sect3"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="namespaceboost_1_1process_1args_append_var"></a>Appending values</h4></div></div></div> +<div class="toc"><dl class="toc"><dt><span class="sect4"><a href="args.html#namespaceboost_1_1process_1args_append_var_value">value</a></span></dt></dl></div> +<p>To append a the argument vector the following syntax can be used.</p> +<pre class="programlisting"><span class="identifier">args</span> <span class="special">+=</span> <span class="identifier">value</span><span class="special">;</span> +</pre> +<p><code class="computeroutput">std::initializer_list</code> is among the allowed types, so the following syntax is also possible.</p> +<pre class="programlisting"><span class="identifier">args</span> <span class="special">+=</span> <span class="special">{</span><span class="identifier">value1</span><span class="special">,</span> <span class="identifier">value2</span><span class="special">}</span><span class="special">;</span> +</pre> +<p>Below the possible types for <code class="computeroutput">value</code> are listed, with <code class="computeroutput">char_type</code> being either <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>.</p> +<div class="sect4"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="namespaceboost_1_1process_1args_append_var_value"></a>value</h5></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type *</code></p></li> +<li class="listitem"><p><code class="computeroutput">std::initializer_list<const char_type *></code></p></li> +<li class="listitem"><p><code class="computeroutput">std::vector<std::basic_string<char_type>></code></p></li> +</ul></div> +<p> +</p> +<p>Additionally any range of <code class="computeroutput">std::basic_string<char_type></code> can be passed.</p> +</div> +</div> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1args_example"></a>Example</h3></div></div></div> +<p>The overload form is used when more than one string is passed, from the second one forward. I.e. the following expressions have the same results:</p> +<pre class="programlisting"><span class="identifier">spawn</span><span class="special">(</span><span class="string">"gcc"</span><span class="special">,</span> <span class="string">"--version"</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">spawn</span><span class="special">(</span><span class="string">"gcc"</span><span class="special">,</span> <span class="identifier">args</span> <span class="special">=</span><span class="string">"--version"</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">spawn</span><span class="special">(</span><span class="string">"gcc"</span><span class="special">,</span> <span class="identifier">args</span><span class="special">+=</span><span class="string">"--version"</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">spawn</span><span class="special">(</span><span class="string">"gcc"</span><span class="special">,</span> <span class="identifier">args</span> <span class="special">=</span><span class="special">{</span><span class="string">"--version"</span><span class="special">}</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">spawn</span><span class="special">(</span><span class="string">"gcc"</span><span class="special">,</span> <span class="identifier">args</span><span class="special">+=</span><span class="special">{</span><span class="string">"--version"</span><span class="special">}</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>A string will be parsed and set in quotes if it has none and contains spaces. </p></td></tr> +</table></div> +<p> +</p> +</div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="../../process/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.args_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="argv.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/argv.html b/doc/html/boost/process/argv.html new file mode 100644 index 0000000000..40237bfc07 --- /dev/null +++ b/doc/html/boost/process/argv.html @@ -0,0 +1,51 @@ +<!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 argv</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.args_hpp" title="Header <boost/process/args.hpp>"> +<link rel="prev" href="args.html" title="Global args"> +<link rel="next" href="on_exit.html" title="Global on_exit"> +</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="args.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.args_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="on_exit.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.argv"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global argv</span></h2> +<p>boost::process::argv — Alias for <a class="link" href="args.html" title="Global args">args</a> . </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: <<a class="link" href="../../process/reference.html#header.boost.process.args_hpp" title="Header <boost/process/args.hpp>">boost/process/args.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> argv<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="args.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.args_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="on_exit.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/async_pipe.html b/doc/html/boost/process/async_pipe.html new file mode 100644 index 0000000000..37bd6b8323 --- /dev/null +++ b/doc/html/boost/process/async_pipe.html @@ -0,0 +1,416 @@ +<!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>Class async_pipe</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_pipe_hpp" title="Header <boost/process/async_pipe.hpp>"> +<link rel="prev" href="on_exit.html" title="Global on_exit"> +<link rel="next" href="async_system.html" title="Function template async_system"> +</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="on_exit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.async_pipe_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_system.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.async_pipe"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class async_pipe</span></h2> +<p>boost::process::async_pipe</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: <<a class="link" href="../../process/reference.html#header.boost.process.async_pipe_hpp" title="Header <boost/process/async_pipe.hpp>">boost/process/async_pipe.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="async_pipe.html#boost.process.async_pipetypes">types</a></span> + <span class="keyword">typedef</span> <span class="identifier">platform_specific</span> <a class="link" href="async_pipe.html#boost.process.async_pipe.native_handle_type"><span class="identifier">native_handle_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">platform_specific</span> <a class="link" href="async_pipe.html#boost.process.async_pipe.handle_type"><span class="identifier">handle_type</span></a><span class="special">;</span> + + <span class="comment">// <a class="link" href="async_pipe.html#boost.process.async_pipeconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="async_pipe.html#idp38064752-bb"><span class="identifier">async_pipe</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="async_pipe.html#idp38067360-bb"><span class="identifier">async_pipe</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="async_pipe.html#idp38070480-bb"><span class="identifier">async_pipe</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="async_pipe.html#idp38073728-bb"><span class="identifier">async_pipe</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="async_pipe.html#idp38077504-bb"><span class="identifier">async_pipe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="async_pipe.html#idp38079776-bb"><span class="identifier">async_pipe</span></a><span class="special">(</span><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> + <span class="keyword">explicit</span> <a class="link" href="async_pipe.html#idp38081296-bb"><span class="identifier">async_pipe</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> + <span class="keyword">explicit</span> <a class="link" href="async_pipe.html#idp38085936-bb"><span class="identifier">async_pipe</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> + <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span> <a class="link" href="async_pipe.html#idp38091296-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span> <a class="link" href="async_pipe.html#idp38096208-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span> <a class="link" href="async_pipe.html#idp38098880-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="async_pipe.html#idp38100912-bb"><span class="special">~</span><span class="identifier">async_pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="async_pipe.html#idp38020144-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> + <span class="keyword">explicit</span> <a class="link" href="async_pipe.html#idp38020640-bb"><span class="keyword">operator</span> <span class="identifier">basic_pipe</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="async_pipe.html#idp38024384-bb"><span class="identifier">cancel</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="async_pipe.html#idp38025520-bb"><span class="identifier">close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="async_pipe.html#idp38026656-bb"><span class="identifier">close</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="async_pipe.html#idp38028416-bb"><span class="identifier">is_open</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="async_pipe.html#idp38029792-bb"><span class="identifier">async_close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="async_pipe.html#idp38031744-bb"><span class="identifier">read_some</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="async_pipe.html#idp38034512-bb"><span class="identifier">write_some</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">native_handle</span> <a class="link" href="async_pipe.html#idp38037280-bb"><span class="identifier">native_source</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">native_handle</span> <a class="link" href="async_pipe.html#idp38038656-bb"><span class="identifier">native_sink</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">,</span> <span class="keyword">typename</span> ReadHandler<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="async_pipe.html#idp38040032-bb"><span class="identifier">async_read_some</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">ReadHandler</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ConstBufferSequence<span class="special">,</span> <span class="keyword">typename</span> WriteHandler<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="async_pipe.html#idp38044768-bb"><span class="identifier">async_write_some</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">WriteHandler</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">handle_type</span> <span class="special">&</span> <a class="link" href="async_pipe.html#idp38049520-bb"><span class="identifier">sink</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">handle_type</span> <span class="special">&</span> <a class="link" href="async_pipe.html#idp38050768-bb"><span class="identifier">source</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">handle_type</span> <span class="special">&&</span> <a class="link" href="async_pipe.html#idp38052016-bb"><span class="identifier">sink</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">handle_type</span> <span class="special">&&</span> <a class="link" href="async_pipe.html#idp38053104-bb"><span class="identifier">source</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">handle_type</span> <a class="link" href="async_pipe.html#idp38054192-bb"><span class="identifier">source</span></a><span class="special">(</span><span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">handle_type</span> <a class="link" href="async_pipe.html#idp38056688-bb"><span class="identifier">sink</span></a><span class="special">(</span><span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">handle_type</span> <a class="link" href="async_pipe.html#idp38059184-bb"><span class="identifier">source</span></a><span class="special">(</span><span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">handle_type</span> <a class="link" href="async_pipe.html#idp38061904-bb"><span class="identifier">sink</span></a><span class="special">(</span><span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp432246912"></a><h2>Description</h2> +<p>Class implementing and asnychronous I/O-Object for use with boost.asio. It is based on the corresponding I/O Object, that is either boost::asio::windows::stream_handle or boost::asio::posix::stream_descriptor.</p> +<p>It can be used directly with boost::asio::async_read or async_write.</p> +<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 object is copyable, but that does invoke a handle duplicate. </p></td></tr> +</table></div> +<p> +</p> +<div class="refsect2"> +<a name="idp432248864"></a><h3> +<a name="boost.process.async_pipetypes"></a><code class="computeroutput">async_pipe</code> + public + types</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<p> +<span class="keyword">typedef</span> <span class="identifier">platform_specific</span> <a name="boost.process.async_pipe.native_handle_type"></a><span class="identifier">native_handle_type</span><span class="special">;</span></p> +<p>Typedef for the native handle representation. </p> +<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>This is the handle on the system, not the boost.asio class. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<p> +<span class="keyword">typedef</span> <span class="identifier">platform_specific</span> <a name="boost.process.async_pipe.handle_type"></a><span class="identifier">handle_type</span><span class="special">;</span></p> +<p>Typedef for the handle representation of boost.asio. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp432259248"></a><h3> +<a name="boost.process.async_pipeconstruct-copy-destruct"></a><code class="computeroutput">async_pipe</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idp38064752-bb"></a><span class="identifier">async_pipe</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios<span class="special">)</span><span class="special">;</span></pre> +<p>Construct a new <code class="computeroutput"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a></code>, does automatically open the pipe. Initializes source and sink with the same io_service. </p> +<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>Windows creates a named pipe here, where the name is automatically generated. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38067360-bb"></a><span class="identifier">async_pipe</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios_source<span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios_sink<span class="special">)</span><span class="special">;</span></pre> +<p>Construct a new <code class="computeroutput"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a></code>, does automatically open the pipe. </p> +<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>Windows creates a named pipe here, where the name is automatically generated. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38070480-bb"></a><span class="identifier">async_pipe</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span></pre> +<p>Construct a new <code class="computeroutput"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a></code>, does automatically open. Initializes source and sink with the same io_service.</p> +<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>Windows restricts possible names. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38073728-bb"></a><span class="identifier">async_pipe</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios_source<span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios_sink<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span></pre> +<p>Construct a new <code class="computeroutput"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a></code>, does automatically open.</p> +<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>Windows restricts possible names. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38077504-bb"></a><span class="identifier">async_pipe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span> lhs<span class="special">)</span><span class="special">;</span></pre> +<p>Copy-Constructor of the async pipe. </p> +<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>Windows requires a named pipe for this, if a the wrong type is used an exception is thrown. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38079776-bb"></a><span class="identifier">async_pipe</span><span class="special">(</span><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre> +<p>Move-Constructor of the async pipe. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> + <span class="keyword">explicit</span> <a name="idp38081296-bb"></a><span class="identifier">async_pipe</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios<span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<p>Construct the async-pipe from a pipe. </p> +<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>Windows requires a named pipe for this, if a the wrong type is used an exception is thrown. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> + <span class="keyword">explicit</span> <a name="idp38085936-bb"></a><span class="identifier">async_pipe</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios_source<span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios_sink<span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<p>Construct the async-pipe from a pipe, with two different io_service objects. </p> +<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>Windows requires a named pipe for this, if a the wrong type is used an exception is thrown. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> + <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span> <a name="idp38091296-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<p>Assign a <code class="computeroutput"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a></code>. </p> +<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>Windows requires a named pipe for this, if a the wrong type is used an exception is thrown. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span> <a name="idp38096208-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span> lhs<span class="special">)</span><span class="special">;</span></pre> +<p>Copy Assign a pipe. </p> +<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>Duplicates the handles. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&</span> <a name="idp38098880-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre> +<p>Move assign a pipe </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38100912-bb"></a><span class="special">~</span><span class="identifier">async_pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Destructor. Closes the pipe handles. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp432419280"></a><h3> +<a name="idp38020144-bb"></a><code class="computeroutput">async_pipe</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> + <span class="keyword">explicit</span> <a name="idp38020640-bb"></a><span class="keyword">operator</span> <span class="identifier">basic_pipe</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Explicit cast to <code class="computeroutput"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a></code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38024384-bb"></a><span class="identifier">cancel</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Cancel the current asynchronous operations. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38025520-bb"></a><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Close the pipe handles. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38026656-bb"></a><span class="identifier">close</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span><span class="special">;</span></pre> +<p>Close the pipe handles. While passing an error_code </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38028416-bb"></a><span class="identifier">is_open</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Check if the pipes are open. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38029792-bb"></a><span class="identifier">async_close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Async close, i.e. close after current operation is completed.</p> +<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>There is no guarantee that this will indeed read the entire pipe-buffer </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp38031744-bb"></a><span class="identifier">read_some</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> buffers<span class="special">)</span><span class="special">;</span></pre> +<p>Read some data from the handle.</p> +<p>See the boost.asio documentation for more details. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp38034512-bb"></a><span class="identifier">write_some</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> buffers<span class="special">)</span><span class="special">;</span></pre> +<p>Write some data to the handle.</p> +<p>See the boost.asio documentation for more details. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">native_handle</span> <a name="idp38037280-bb"></a><span class="identifier">native_source</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the native handle of the source. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">native_handle</span> <a name="idp38038656-bb"></a><span class="identifier">native_sink</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the native handle of the sink. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">,</span> <span class="keyword">typename</span> ReadHandler<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idp38040032-bb"></a><span class="identifier">async_read_some</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> buffers<span class="special">,</span> + <span class="identifier">ReadHandler</span> <span class="special">&&</span> handler<span class="special">)</span><span class="special">;</span></pre> +<p>Start an asynchronous read.</p> +<p>See the <a href="http://www.boost.org/doc/libs/1_60_0/doc/html/boost_asio/reference/AsyncReadStream.html" target="_top">boost.asio documentation</a> for more details. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ConstBufferSequence<span class="special">,</span> <span class="keyword">typename</span> WriteHandler<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idp38044768-bb"></a><span class="identifier">async_write_some</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> buffers<span class="special">,</span> + <span class="identifier">WriteHandler</span> <span class="special">&&</span> handler<span class="special">)</span><span class="special">;</span></pre> +<p>Start an asynchronous write.</p> +<p>See the <a href="http://www.boost.org/doc/libs/1_60_0/doc/html/boost_asio/reference/AsyncWriteStream.html" target="_top">boost.asio documentation</a> for more details. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">handle_type</span> <span class="special">&</span> <a name="idp38049520-bb"></a><span class="identifier">sink</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get the asio handle of the pipe sink. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">handle_type</span> <span class="special">&</span> <a name="idp38050768-bb"></a><span class="identifier">source</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get the asio handle of the pipe source. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">handle_type</span> <span class="special">&&</span> <a name="idp38052016-bb"></a><span class="identifier">sink</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get the asio handle of the pipe sink. Qualified as rvalue. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">handle_type</span> <span class="special">&&</span> <a name="idp38053104-bb"></a><span class="identifier">source</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get the asio handle of the pipe source. Qualified as rvalue. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">handle_type</span> <a name="idp38054192-bb"></a><span class="identifier">source</span><span class="special">(</span><span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios<span class="special">)</span><span class="special">;</span></pre>Move the source out of this class and change the io_service. Qualified as rvalue. <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>Will always move. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">handle_type</span> <a name="idp38056688-bb"></a><span class="identifier">sink</span><span class="special">(</span><span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios<span class="special">)</span><span class="special">;</span></pre>Move the sink out of this class and change the io_service. Qualified as rvalue. <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>Will always move </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">handle_type</span> <a name="idp38059184-bb"></a><span class="identifier">source</span><span class="special">(</span><span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Copy the source out of this class and change the io_service. <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>Will always copy. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">handle_type</span> <a name="idp38061904-bb"></a><span class="identifier">sink</span><span class="special">(</span><span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Copy the sink out of this class and change the io_service. <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>Will always copy </p></td></tr> +</table></div> +<p> +</p> +</li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="on_exit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.async_pipe_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_system.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/async_system.html b/doc/html/boost/process/async_system.html new file mode 100644 index 0000000000..509bad2a3b --- /dev/null +++ b/doc/html/boost/process/async_system.html @@ -0,0 +1,96 @@ +<!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>Function template async_system</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_system_hpp" title="Header <boost/process/async_system.hpp>"> +<link rel="prev" href="async_pipe.html" title="Class async_pipe"> +<link rel="next" href="child.html" title="Class child"> +</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="async_pipe.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.async_system_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="child.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.async_system"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template async_system</span></h2> +<p>boost::process::async_system</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: <<a class="link" href="../../process/reference.html#header.boost.process.async_system_hpp" title="Header <boost/process/async_system.hpp>">boost/process/async_system.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ExitHandler<span class="special">,</span> <span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">async_system</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> ios<span class="special">,</span> + <span class="identifier">ExitHandler</span> <span class="special">&&</span> exit_handler<span class="special">,</span> <span class="identifier">Args</span> <span class="special">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp432631904"></a><h2>Description</h2> +<p>This function provides an asynchronous interface to process launching.</p> +<p>It uses the same properties and parameters as the other launching function, but is similar to the asynchronous functions in <a href="http://www.boost.org/doc/libs/release/doc/html/boost_asio.html" target="_top">boost.asio</a></p> +<p>It uses <a href="http://www.boost.org/doc/libs/release/doc/html/boost_asio/reference/async_result.html" target="_top">asio::async_result</a> to determine the return value (from the second parameter, <code class="computeroutput">exit_handler</code>).</p> +<p> +</p> +<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>This function does not allow custom error handling, since those are done through the <code class="computeroutput">exit_handler</code>. </p></td></tr> +</table></div> +<p> +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">exit_handler</code></span></p></td> +<td><p>The exit-handler for the signature <code class="computeroutput">void(boost::system::error_code, int)</code></p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">ios</code></span></p></td> +<td><p>A reference to an <a href="http://www.boost.org/doc/libs/release/doc/html/boost_asio/reference.html" target="_top">io_service</a> </p></td> +</tr> +</tbody> +</table></div></td> +</tr></tbody> +</table></div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="async_pipe.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.async_system_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="child.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_environment.html b/doc/html/boost/process/basic_environment.html new file mode 100644 index 0000000000..99c8518581 --- /dev/null +++ b/doc/html/boost/process/basic_environment.html @@ -0,0 +1,205 @@ +<!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>Class template basic_environment</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.environment_hpp" title="Header <boost/process/environment.hpp>"> +<link rel="prev" href="env.html" title="Global env"> +<link rel="next" href="basic_environment/const_entry_type.html" title="Struct template const_entry_type"> +</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="env.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.environment_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="basic_environment/const_entry_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_environment"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template basic_environment</span></h2> +<p>boost::process::basic_environment — Type definition to hold a seperate environment. </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: <<a class="link" href="../../process/reference.html#header.boost.process.environment_hpp" title="Header <boost/process/environment.hpp>">boost/process/environment.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Char</span> <span class="special">></span> <a name="boost.process.basic_environment.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">transform_iterator</span><span class="special"><</span> <span class="identifier">entry_maker</span><span class="special">,</span> <span class="identifier">Char</span> <span class="special">*</span><span class="special">*</span> <span class="special">></span> <a name="boost.process.basic_environment.iterator"></a><span class="identifier">iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">transform_iterator</span><span class="special"><</span> <span class="identifier">const_entry_maker</span><span class="special">,</span> <span class="identifier">Char</span> <span class="special">*</span><span class="special">*</span> <span class="special">></span> <a name="boost.process.basic_environment.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="boost.process.basic_environment.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.basic_environment.native_handle"></a><span class="identifier">native_handle</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.basic_environment.base_type"></a><span class="identifier">base_type</span><span class="special">;</span> + + <span class="comment">// member classes/structs/unions</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="basic_environment/const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Char</span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.value_type"><span class="identifier">value_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.pointer"><span class="identifier">pointer</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.string_type"><span class="identifier">string_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.range"><span class="identifier">range</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.environment_t"><span class="identifier">environment_t</span></a><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="identifier">const_entry</span> <span class="special">&</span> <a class="link" href="basic_environment/const_entry_type.html#idp38253424-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_environment/const_entry_type.html#idp38248096-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="basic_environment/const_entry_type.html#idp38248592-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_environment/const_entry_type.html#idp38250304-bb"><span class="identifier">const_entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_environment/const_entry_type.html#idp38252048-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="special">}</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Char</span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.value_type"><span class="identifier">value_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.pointer"><span class="identifier">pointer</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.string_type"><span class="identifier">string_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.range"><span class="identifier">range</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.environment_t"><span class="identifier">environment_t</span></a><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idp38274640-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idp38276272-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idp38277664-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_environment/entry_type.html#idp38261488-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="basic_environment/entry_type.html#idp38261984-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_environment/entry_type.html#idp38263696-bb"><span class="identifier">entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_environment/entry_type.html#idp38265440-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idp38266688-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idp38268320-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idp38270048-bb"><span class="identifier">append</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idp38271776-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idp38272784-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="special">}</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_environment.html#boost.process.basic_environmentconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_environment.html#idp38310752-bb"><span class="identifier">basic_environment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_environment.html#idp38311264-bb"><span class="identifier">basic_environment</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_environment.html#idp38312784-bb"><span class="identifier">basic_environment</span></a><span class="special">(</span><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a class="link" href="basic_environment.html#idp38314176-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a class="link" href="basic_environment.html#idp38316208-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_environment.html#idp38283920-bb">public member functions</a></span> + <span class="identifier">iterator</span> <a class="link" href="basic_environment.html#idp38284416-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp38285424-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp38286672-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_environment.html#idp38287920-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp38288928-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp38290176-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_environment.html#idp38291424-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp38293056-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="basic_environment.html#idp38294928-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_environment.html#idp38296800-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</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">pair</span><span class="special"><</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> + <a class="link" href="basic_environment.html#idp38298560-bb"><span class="identifier">emplace</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_environment.html#idp38300816-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="basic_environment.html#idp38301824-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_environment.html#idp38303072-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a class="link" href="basic_environment.html#idp38304848-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_environment/const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <a class="link" href="basic_environment.html#idp38306688-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a class="link" href="basic_environment.html#idp38308768-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp433648384"></a><h2>Description</h2> +<p>Template representation of environments. It takes a character type (<code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>) as template parameter to implement the environment </p> +<div class="refsect2"> +<a name="idp433650608"></a><h3> +<a name="boost.process.basic_environmentconstruct-copy-destruct"></a><code class="computeroutput">basic_environment</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idp38310752-bb"></a><span class="identifier">basic_environment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38311264-bb"></a><span class="identifier">basic_environment</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre>Copy constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38312784-bb"></a><span class="identifier">basic_environment</span><span class="special">(</span><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre>Move constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a name="idp38314176-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre>Copy assignment. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a name="idp38316208-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre>Move assignment. </li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp433682768"></a><h3> +<a name="idp38283920-bb"></a><code class="computeroutput">basic_environment</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp38284416-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns an iterator to the beginning. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38285424-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the beginning. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38286672-bb"></a><span class="identifier">cbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the beginning. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp38287920-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns an iterator to the end. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38288928-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the end. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38290176-bb"></a><span class="identifier">cend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the end. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp38291424-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>Find a variable by its name. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38293056-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Find a variable by its name. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp38294928-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> st<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Number of variables. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38296800-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> id<span class="special">)</span><span class="special">;</span></pre> +<p>Erase variable by id. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> +<a name="idp38298560-bb"></a><span class="identifier">emplace</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> id<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Emplace an environment variable. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38300816-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Check if environment has entries. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp38301824-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get the number of variables. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38303072-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Clear the environment. <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>Use with care, passed environment cannot be empty. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a name="idp38304848-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>Get the entry with the key. Throws if it does not exist. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_environment/const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <a name="idp38306688-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get the entry with the key. Throws if it does not exist. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a name="idp38308768-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>Get the entry with the given key. It creates the entry if it doesn't exist. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="env.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.environment_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="basic_environment/const_entry_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_environment/const_entry_type.html b/doc/html/boost/process/basic_environment/const_entry_type.html new file mode 100644 index 0000000000..65b3c75561 --- /dev/null +++ b/doc/html/boost/process/basic_environment/const_entry_type.html @@ -0,0 +1,102 @@ +<!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>Struct template const_entry_type</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="../basic_environment.html#idp433648384" title="Description"> +<link rel="prev" href="../basic_environment.html" title="Class template basic_environment"> +<link rel="next" href="entry_type.html" title="Struct template entry_type"> +</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="../basic_environment.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_environment.html#idp433648384"><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="entry_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_environment.const_entry_type"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template const_entry_type</span></h2> +<p>boost::process::basic_environment::const_entry_type</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: <<a class="link" href="../../../process/reference.html#header.boost.process.environment_hpp" title="Header <boost/process/environment.hpp>">boost/process/environment.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Char</span> <a name="boost.process.basic_environment.const_entry_type.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a name="boost.process.basic_environment.const_entry_type.pointer"></a><span class="identifier">pointer</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a name="boost.process.basic_environment.const_entry_type.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a name="boost.process.basic_environment.const_entry_type.range"></a><span class="identifier">range</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a name="boost.process.basic_environment.const_entry_type.environment_t"></a><span class="identifier">environment_t</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="const_entry_type.html#boost.process.basic_environment.const_entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="identifier">const_entry</span> <span class="special">&</span> <a class="link" href="const_entry_type.html#idp38253424-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="const_entry_type.html#idp38248096-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="const_entry_type.html#idp38248592-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="const_entry_type.html#idp38250304-bb"><span class="identifier">const_entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="const_entry_type.html#idp38252048-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp433858096"></a><h2>Description</h2> +<p>Proxy class used for read access to members by [] or .at() </p> +<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>Holds a reference to the environment it was created from. </p></td></tr> +</table></div> +<p> +</p> +<div class="refsect2"> +<a name="idp433859440"></a><h3> +<a name="boost.process.basic_environment.const_entry_typeconstruct-copy-destruct"></a><code class="computeroutput">const_entry_type</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="identifier">const_entry</span> <span class="special">&</span> <a name="idp38253424-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move Constructor. </li></ol></div> +</div> +<div class="refsect2"> +<a name="idp433870768"></a><h3> +<a name="idp38248096-bb"></a><code class="computeroutput">const_entry_type</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a name="idp38248592-bb"></a><span class="identifier">to_vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Split the entry by ";" or ":" and return it as a vector. Used by PATH. <p>Get the value as string. Get the name of this entry. </p> +</li> +<li class="listitem"> +<pre class="literallayout"> <a name="idp38250304-bb"></a><span class="identifier">const_entry</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Copy Constructor. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38252048-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Check if the entry is empty. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="../basic_environment.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_environment.html#idp433648384"><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="entry_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_environment/entry_type.html b/doc/html/boost/process/basic_environment/entry_type.html new file mode 100644 index 0000000000..87a51f9616 --- /dev/null +++ b/doc/html/boost/process/basic_environment/entry_type.html @@ -0,0 +1,125 @@ +<!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>Struct template entry_type</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="../basic_environment.html#idp433648384" title="Description"> +<link rel="prev" href="const_entry_type.html" title="Struct template const_entry_type"> +<link rel="next" href="../basic_native_environment.html" title="Class template basic_native_environment"> +</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="const_entry_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_environment.html#idp433648384"><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="../basic_native_environment.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_environment.entry_type"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template entry_type</span></h2> +<p>boost::process::basic_environment::entry_type</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: <<a class="link" href="../../../process/reference.html#header.boost.process.environment_hpp" title="Header <boost/process/environment.hpp>">boost/process/environment.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="entry_type.html" title="Struct template entry_type">entry_type</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Char</span> <a name="boost.process.basic_environment.entry_type.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a name="boost.process.basic_environment.entry_type.pointer"></a><span class="identifier">pointer</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a name="boost.process.basic_environment.entry_type.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a name="boost.process.basic_environment.entry_type.range"></a><span class="identifier">range</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a name="boost.process.basic_environment.entry_type.environment_t"></a><span class="identifier">environment_t</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="entry_type.html#boost.process.basic_environment.entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="entry_type.html#idp38274640-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="entry_type.html#idp38276272-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="entry_type.html#idp38277664-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="entry_type.html#idp38261488-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="entry_type.html#idp38261984-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="entry_type.html#idp38263696-bb"><span class="identifier">entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="entry_type.html#idp38265440-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38266688-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38268320-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38270048-bb"><span class="identifier">append</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38271776-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="entry_type.html#idp38272784-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp434002368"></a><h2>Description</h2> +<p>Proxy class used for read and write access to members by [] or .at() </p> +<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>Holds a reference to the environment it was created from. </p></td></tr> +</table></div> +<p> +</p> +<div class="refsect2"> +<a name="idp434003712"></a><h3> +<a name="boost.process.basic_environment.entry_typeconstruct-copy-destruct"></a><code class="computeroutput">entry_type</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&</span> <a name="idp38274640-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move Constructor. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&</span> <a name="idp38276272-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a string to the entry. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&</span> <a name="idp38277664-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a set of strings to the entry; they will be seperated by ';' or ':'. </li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp434033696"></a><h3> +<a name="idp38261488-bb"></a><code class="computeroutput">entry_type</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a name="idp38261984-bb"></a><span class="identifier">to_vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Split the entry by ";" or ":" and return it as a vector. Used by PATH. <p>Get the value as string. Get the name of this entry. </p> +</li> +<li class="listitem"> +<pre class="literallayout"> <a name="idp38263696-bb"></a><span class="identifier">entry</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Copy Constructor. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38265440-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Check if the entry is empty. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38266688-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a string to the value. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38268320-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a set of strings to the entry; they will be seperated by ';' or ':'. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38270048-bb"></a><span class="identifier">append</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Append a string to the end of the entry, it will seperated by ';' or ':'. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38271776-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Reset the value. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&</span> <a name="idp38272784-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Append a string to the end of the entry, it will seperated by ';' or ':'. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="const_entry_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_environment.html#idp433648384"><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="../basic_native_environment.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_ipstream.html b/doc/html/boost/process/basic_ipstream.html new file mode 100644 index 0000000000..a710c5876e --- /dev/null +++ b/doc/html/boost/process/basic_ipstream.html @@ -0,0 +1,128 @@ +<!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>Class template basic_ipstream</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.pipe_hpp" title="Header <boost/process/pipe.hpp>"> +<link rel="prev" href="basic_pipebuf.html" title="Struct template basic_pipebuf"> +<link rel="next" href="basic_opstream.html" title="Class template basic_opstream"> +</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="basic_pipebuf.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="basic_opstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_ipstream"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template basic_ipstream</span></h2> +<p>boost::process::basic_ipstream</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: <<a class="link" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header <boost/process/pipe.hpp>">boost/process/pipe.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> +<span class="keyword">class</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <a name="boost.process.basic_ipstream.pipe_type"></a><span class="identifier">pipe_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">CharT</span> <a name="boost.process.basic_ipstream.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span> <a name="boost.process.basic_ipstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">int_type</span> <a name="boost.process.basic_ipstream.int_type"></a><span class="identifier">int_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">pos_type</span> <a name="boost.process.basic_ipstream.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">off_type</span> <a name="boost.process.basic_ipstream.off_type"></a><span class="identifier">off_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_ipstream.html#boost.process.basic_ipstreamconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_ipstream.html#idp38910688-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html#idp38911264-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html#idp38913248-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html#idp38915072-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html#idp38916640-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span> <a class="link" href="basic_ipstream.html#idp38918368-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span> <a class="link" href="basic_ipstream.html#idp38920928-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span> <a class="link" href="basic_ipstream.html#idp38923328-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span> <a class="link" href="basic_ipstream.html#idp38925472-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_ipstream.html#idp38899040-bb">public member functions</a></span> + <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_ipstream.html#idp38899600-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idp38901328-bb"><span class="identifier">pipe</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idp38903456-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span> <a class="link" href="basic_ipstream.html#idp38905744-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span> <a class="link" href="basic_ipstream.html#idp38907184-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&&</span> <a class="link" href="basic_ipstream.html#idp38909056-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp437481424"></a><h2>Description</h2> +<p>Implementation of a reading pipe stream. </p> +<div class="refsect2"> +<a name="idp437482160"></a><h3> +<a name="boost.process.basic_ipstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_ipstream</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idp38910688-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38911264-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38913248-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38915072-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Move construct from a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38916640-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Copy construct from a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span> <a name="idp38918368-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy assignment. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span> <a name="idp38920928-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move assignment. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span> <a name="idp38923328-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Move assignment of a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&</span> <a name="idp38925472-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Copy assignment of a pipe. </li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp437546320"></a><h3> +<a name="idp38899040-bb"></a><code class="computeroutput">basic_ipstream</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">*</span> <a name="idp38899600-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get access to the underlying stream_buf. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38901328-bb"></a><span class="identifier">pipe</span><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38903456-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span> <a name="idp38905744-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a reference to the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&</span> <a name="idp38907184-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get a const reference to the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&&</span> <a name="idp38909056-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a rvalue reference to the pipe. Qualified as rvalue. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="basic_pipebuf.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="basic_opstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_native_environment.html b/doc/html/boost/process/basic_native_environment.html new file mode 100644 index 0000000000..dca17b49a0 --- /dev/null +++ b/doc/html/boost/process/basic_native_environment.html @@ -0,0 +1,187 @@ +<!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>Class template basic_native_environment</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.environment_hpp" title="Header <boost/process/environment.hpp>"> +<link rel="prev" href="basic_environment/entry_type.html" title="Struct template entry_type"> +<link rel="next" href="basic_native_environment/const_entry_type.html" title="Struct template const_entry_type"> +</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="basic_environment/entry_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.environment_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="basic_native_environment/const_entry_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_native_environment"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template basic_native_environment</span></h2> +<p>boost::process::basic_native_environment — Definition of the environment for the current process. </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: <<a class="link" href="../../process/reference.html#header.boost.process.environment_hpp" title="Header <boost/process/environment.hpp>">boost/process/environment.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="basic_native_environment.html" title="Class template basic_native_environment">basic_native_environment</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Char</span> <span class="special">></span> <a name="boost.process.basic_native_environment.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">transform_iterator</span><span class="special"><</span> <span class="identifier">entry_maker</span><span class="special">,</span> <span class="identifier">Char</span> <span class="special">*</span><span class="special">*</span> <span class="special">></span> <a name="boost.process.basic_native_environment.iterator"></a><span class="identifier">iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">transform_iterator</span><span class="special"><</span> <span class="identifier">const_entry_maker</span><span class="special">,</span> <span class="identifier">Char</span> <span class="special">*</span><span class="special">*</span> <span class="special">></span> <a name="boost.process.basic_native_environment.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="boost.process.basic_native_environment.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.basic_native_environment.native_handle"></a><span class="identifier">native_handle</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.basic_native_environment.base_type"></a><span class="identifier">base_type</span><span class="special">;</span> + + <span class="comment">// member classes/structs/unions</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="basic_native_environment/const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Char</span> <a class="link" href="basic_native_environment/const_entry_type.html#boost.process.basic_native_environment.const_entry_type.value_type"><span class="identifier">value_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a class="link" href="basic_native_environment/const_entry_type.html#boost.process.basic_native_environment.const_entry_type.pointer"><span class="identifier">pointer</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a class="link" href="basic_native_environment/const_entry_type.html#boost.process.basic_native_environment.const_entry_type.string_type"><span class="identifier">string_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a class="link" href="basic_native_environment/const_entry_type.html#boost.process.basic_native_environment.const_entry_type.range"><span class="identifier">range</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a class="link" href="basic_native_environment/const_entry_type.html#boost.process.basic_native_environment.const_entry_type.environment_t"><span class="identifier">environment_t</span></a><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_native_environment/const_entry_type.html#boost.process.basic_native_environment.const_entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="identifier">const_entry</span> <span class="special">&</span> <a class="link" href="basic_native_environment/const_entry_type.html#idp38331952-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_native_environment/const_entry_type.html#idp38326560-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="basic_native_environment/const_entry_type.html#idp38327056-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_native_environment/const_entry_type.html#idp38328768-bb"><span class="identifier">const_entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_native_environment/const_entry_type.html#idp38330512-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="special">}</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="basic_native_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Char</span> <a class="link" href="basic_native_environment/entry_type.html#boost.process.basic_native_environment.entry_type.value_type"><span class="identifier">value_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a class="link" href="basic_native_environment/entry_type.html#boost.process.basic_native_environment.entry_type.pointer"><span class="identifier">pointer</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a class="link" href="basic_native_environment/entry_type.html#boost.process.basic_native_environment.entry_type.string_type"><span class="identifier">string_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a class="link" href="basic_native_environment/entry_type.html#boost.process.basic_native_environment.entry_type.range"><span class="identifier">range</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a class="link" href="basic_native_environment/entry_type.html#boost.process.basic_native_environment.entry_type.environment_t"><span class="identifier">environment_t</span></a><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_native_environment/entry_type.html#boost.process.basic_native_environment.entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_native_environment/entry_type.html#idp38355600-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_native_environment/entry_type.html#idp38357424-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_native_environment/entry_type.html#idp38358992-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_native_environment/entry_type.html#idp38340944-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="basic_native_environment/entry_type.html#idp38341504-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_native_environment/entry_type.html#idp38343424-bb"><span class="identifier">entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_native_environment/entry_type.html#idp38345360-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_native_environment/entry_type.html#idp38346784-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_native_environment/entry_type.html#idp38348624-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_native_environment/entry_type.html#idp38350528-bb"><span class="identifier">append</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_native_environment/entry_type.html#idp38352416-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_native_environment/entry_type.html#idp38353552-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="special">}</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_native_environment.html#boost.process.basic_native_environmentconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_native_environment.html#idp38394176-bb"><span class="identifier">basic_native_environment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_native_environment.html#idp38394752-bb"><span class="identifier">basic_native_environment</span></a><span class="special">(</span><a class="link" href="basic_native_environment.html" title="Class template basic_native_environment">basic_native_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_native_environment.html" title="Class template basic_native_environment">basic_native_environment</a> <span class="special">&</span> <a class="link" href="basic_native_environment.html#idp38396320-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_native_environment.html" title="Class template basic_native_environment">basic_native_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_native_environment.html#idp38366048-bb">public member functions</a></span> + <span class="identifier">iterator</span> <a class="link" href="basic_native_environment.html#idp38366608-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_native_environment.html#idp38367760-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_native_environment.html#idp38369184-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_native_environment.html#idp38370608-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_native_environment.html#idp38371760-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_native_environment.html#idp38373184-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_native_environment.html#idp38374608-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_native_environment.html#idp38376448-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="basic_native_environment.html#idp38378560-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_native_environment.html#idp38380656-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</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">pair</span><span class="special"><</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> + <a class="link" href="basic_native_environment.html#idp38382608-bb"><span class="identifier">emplace</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_native_environment.html#idp38385152-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="basic_native_environment.html#idp38386304-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_native_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a class="link" href="basic_native_environment.html#idp38387728-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_native_environment/const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <a class="link" href="basic_native_environment.html#idp38389728-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_native_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a class="link" href="basic_native_environment.html#idp38392000-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp434414016"></a><h2>Description</h2> +<p>Template representation of the environment of this process. It takes a template as template parameter to implement the environment. All instances of this class refer to the same environment, but might not get updated if another one makes changes. </p> +<div class="refsect2"> +<a name="idp434414944"></a><h3> +<a name="boost.process.basic_native_environmentconstruct-copy-destruct"></a><code class="computeroutput">basic_native_environment</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idp38394176-bb"></a><span class="identifier">basic_native_environment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38394752-bb"></a><span class="identifier">basic_native_environment</span><span class="special">(</span><a class="link" href="basic_native_environment.html" title="Class template basic_native_environment">basic_native_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre>Move constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_native_environment.html" title="Class template basic_native_environment">basic_native_environment</a> <span class="special">&</span> <a name="idp38396320-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_native_environment.html" title="Class template basic_native_environment">basic_native_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre>Move assignment. </li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp434433472"></a><h3> +<a name="idp38366048-bb"></a><code class="computeroutput">basic_native_environment</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp38366608-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns an iterator to the beginning. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38367760-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the beginning. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38369184-bb"></a><span class="identifier">cbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the beginning. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp38370608-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns an iterator to the end. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38371760-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the end. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38373184-bb"></a><span class="identifier">cend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the end. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp38374608-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>Find a variable by its name. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp38376448-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Find a variable by its name. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp38378560-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> st<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Number of variables. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38380656-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> id<span class="special">)</span><span class="special">;</span></pre> +<p>Erase variable by id. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> +<a name="idp38382608-bb"></a><span class="identifier">emplace</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> id<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Emplace an environment variable. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38385152-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Check if environment has entries. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp38386304-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get the number of variables. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_native_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a name="idp38387728-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>Get the entry with the key. Throws if it does not exist. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_native_environment/const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <a name="idp38389728-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get the entry with the key. Throws if it does not exist. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_native_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a name="idp38392000-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>Get the entry with the given key. It creates the entry if it doesn't exist. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="basic_environment/entry_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.environment_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="basic_native_environment/const_entry_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_native_environment/const_entry_type.html b/doc/html/boost/process/basic_native_environment/const_entry_type.html new file mode 100644 index 0000000000..21c4e153ea --- /dev/null +++ b/doc/html/boost/process/basic_native_environment/const_entry_type.html @@ -0,0 +1,102 @@ +<!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>Struct template const_entry_type</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="../basic_native_environment.html#idp434414016" title="Description"> +<link rel="prev" href="../basic_native_environment.html" title="Class template basic_native_environment"> +<link rel="next" href="entry_type.html" title="Struct template entry_type"> +</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="../basic_native_environment.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_native_environment.html#idp434414016"><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="entry_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_native_environment.const_entry_type"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template const_entry_type</span></h2> +<p>boost::process::basic_native_environment::const_entry_type</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: <<a class="link" href="../../../process/reference.html#header.boost.process.environment_hpp" title="Header <boost/process/environment.hpp>">boost/process/environment.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Char</span> <a name="boost.process.basic_native_environment.const_entry_type.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a name="boost.process.basic_native_environment.const_entry_type.pointer"></a><span class="identifier">pointer</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a name="boost.process.basic_native_environment.const_entry_type.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a name="boost.process.basic_native_environment.const_entry_type.range"></a><span class="identifier">range</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a name="boost.process.basic_native_environment.const_entry_type.environment_t"></a><span class="identifier">environment_t</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="const_entry_type.html#boost.process.basic_native_environment.const_entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="identifier">const_entry</span> <span class="special">&</span> <a class="link" href="const_entry_type.html#idp38331952-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="const_entry_type.html#idp38326560-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="const_entry_type.html#idp38327056-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="const_entry_type.html#idp38328768-bb"><span class="identifier">const_entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="const_entry_type.html#idp38330512-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp434603696"></a><h2>Description</h2> +<p>Proxy class used for read access to members by [] or .at() </p> +<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>Holds a reference to the environment it was created from. </p></td></tr> +</table></div> +<p> +</p> +<div class="refsect2"> +<a name="idp434604960"></a><h3> +<a name="boost.process.basic_native_environment.const_entry_typeconstruct-copy-destruct"></a><code class="computeroutput">const_entry_type</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="identifier">const_entry</span> <span class="special">&</span> <a name="idp38331952-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move Constructor. </li></ol></div> +</div> +<div class="refsect2"> +<a name="idp434616304"></a><h3> +<a name="idp38326560-bb"></a><code class="computeroutput">const_entry_type</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a name="idp38327056-bb"></a><span class="identifier">to_vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Split the entry by ";" or ":" and return it as a vector. Used by PATH. <p>Get the value as string. Get the name of this entry. </p> +</li> +<li class="listitem"> +<pre class="literallayout"> <a name="idp38328768-bb"></a><span class="identifier">const_entry</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Copy Constructor. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38330512-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Check if the entry is empty. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="../basic_native_environment.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_native_environment.html#idp434414016"><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="entry_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_native_environment/entry_type.html b/doc/html/boost/process/basic_native_environment/entry_type.html new file mode 100644 index 0000000000..573e9f4e5c --- /dev/null +++ b/doc/html/boost/process/basic_native_environment/entry_type.html @@ -0,0 +1,125 @@ +<!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>Struct template entry_type</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="../basic_native_environment.html#idp434414016" title="Description"> +<link rel="prev" href="const_entry_type.html" title="Struct template const_entry_type"> +<link rel="next" href="../ignore_error.html" title="Global ignore_error"> +</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="const_entry_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_native_environment.html#idp434414016"><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="../ignore_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_native_environment.entry_type"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template entry_type</span></h2> +<p>boost::process::basic_native_environment::entry_type</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: <<a class="link" href="../../../process/reference.html#header.boost.process.environment_hpp" title="Header <boost/process/environment.hpp>">boost/process/environment.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="entry_type.html" title="Struct template entry_type">entry_type</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Char</span> <a name="boost.process.basic_native_environment.entry_type.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a name="boost.process.basic_native_environment.entry_type.pointer"></a><span class="identifier">pointer</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a name="boost.process.basic_native_environment.entry_type.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a name="boost.process.basic_native_environment.entry_type.range"></a><span class="identifier">range</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a name="boost.process.basic_native_environment.entry_type.environment_t"></a><span class="identifier">environment_t</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="entry_type.html#boost.process.basic_native_environment.entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="entry_type.html#idp38355600-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="entry_type.html#idp38357424-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="entry_type.html#idp38358992-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="entry_type.html#idp38340944-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="entry_type.html#idp38341504-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="entry_type.html#idp38343424-bb"><span class="identifier">entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="entry_type.html#idp38345360-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38346784-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38348624-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38350528-bb"><span class="identifier">append</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38352416-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="entry_type.html#idp38353552-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp434748512"></a><h2>Description</h2> +<p>Proxy class used for read and write access to members by [] or .at() </p> +<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>Holds a reference to the environment it was created from. </p></td></tr> +</table></div> +<p> +</p> +<div class="refsect2"> +<a name="idp434749776"></a><h3> +<a name="boost.process.basic_native_environment.entry_typeconstruct-copy-destruct"></a><code class="computeroutput">entry_type</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&</span> <a name="idp38355600-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move Constructor. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&</span> <a name="idp38357424-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a string to the entry. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&</span> <a name="idp38358992-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a set of strings to the entry; they will be seperated by ';' or ':'. </li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp434779488"></a><h3> +<a name="idp38340944-bb"></a><code class="computeroutput">entry_type</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a name="idp38341504-bb"></a><span class="identifier">to_vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Split the entry by ";" or ":" and return it as a vector. Used by PATH. <p>Get the value as string. Get the name of this entry. </p> +</li> +<li class="listitem"> +<pre class="literallayout"> <a name="idp38343424-bb"></a><span class="identifier">entry</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Copy Constructor. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38345360-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Check if the entry is empty. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38346784-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a string to the value. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38348624-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a set of strings to the entry; they will be seperated by ';' or ':'. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38350528-bb"></a><span class="identifier">append</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Append a string to the end of the entry, it will seperated by ';' or ':'. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38352416-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Reset the value. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&</span> <a name="idp38353552-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Append a string to the end of the entry, it will seperated by ';' or ':'. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="const_entry_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_native_environment.html#idp434414016"><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="../ignore_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_opstream.html b/doc/html/boost/process/basic_opstream.html new file mode 100644 index 0000000000..1e1334f582 --- /dev/null +++ b/doc/html/boost/process/basic_opstream.html @@ -0,0 +1,128 @@ +<!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>Class template basic_opstream</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.pipe_hpp" title="Header <boost/process/pipe.hpp>"> +<link rel="prev" href="basic_ipstream.html" title="Class template basic_ipstream"> +<link rel="next" href="basic_pstream.html" title="Class template basic_pstream"> +</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="basic_ipstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="basic_pstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_opstream"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template basic_opstream</span></h2> +<p>boost::process::basic_opstream</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: <<a class="link" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header <boost/process/pipe.hpp>">boost/process/pipe.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> +<span class="keyword">class</span> <a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <a name="boost.process.basic_opstream.pipe_type"></a><span class="identifier">pipe_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">CharT</span> <a name="boost.process.basic_opstream.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span> <a name="boost.process.basic_opstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">int_type</span> <a name="boost.process.basic_opstream.int_type"></a><span class="identifier">int_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">pos_type</span> <a name="boost.process.basic_opstream.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">off_type</span> <a name="boost.process.basic_opstream.off_type"></a><span class="identifier">off_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_opstream.html#boost.process.basic_opstreamconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_opstream.html#idp38947904-bb"><span class="identifier">basic_opstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_opstream.html#idp38948480-bb"><span class="identifier">basic_opstream</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> + <a class="link" href="basic_opstream.html#idp38950464-bb"><span class="identifier">basic_opstream</span></a><span class="special">(</span><a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="basic_opstream.html#idp38952288-bb"><span class="identifier">basic_opstream</span></a><span class="special">(</span><a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_opstream.html#idp38953856-bb"><span class="identifier">basic_opstream</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span> <a class="link" href="basic_opstream.html#idp38955584-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> + <a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span> <a class="link" href="basic_opstream.html#idp38958144-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span> <a class="link" href="basic_opstream.html#idp38960544-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span> <a class="link" href="basic_opstream.html#idp38962688-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_opstream.html#idp38936256-bb">public member functions</a></span> + <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_opstream.html#idp38936816-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_opstream.html#idp38938544-bb"><span class="identifier">pipe</span></a><span class="special">(</span><a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_opstream.html#idp38940672-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span> <a class="link" href="basic_opstream.html#idp38942960-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span> <a class="link" href="basic_opstream.html#idp38944400-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&&</span> <a class="link" href="basic_opstream.html#idp38946272-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp437727264"></a><h2>Description</h2> +<p>Implementation of a write pipe stream. </p> +<div class="refsect2"> +<a name="idp437727984"></a><h3> +<a name="boost.process.basic_opstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_opstream</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idp38947904-bb"></a><span class="identifier">basic_opstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38948480-bb"></a><span class="identifier">basic_opstream</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38950464-bb"></a><span class="identifier">basic_opstream</span><span class="special">(</span><a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38952288-bb"></a><span class="identifier">basic_opstream</span><span class="special">(</span><a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Move construct from a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38953856-bb"></a><span class="identifier">basic_opstream</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Copy construct from a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span> <a name="idp38955584-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy assignment. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span> <a name="idp38958144-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move assignment. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span> <a name="idp38960544-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Move assignment of a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a> <span class="special">&</span> <a name="idp38962688-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Copy assignment of a pipe. </li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp437792208"></a><h3> +<a name="idp38936256-bb"></a><code class="computeroutput">basic_opstream</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">*</span> <a name="idp38936816-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get access to the underlying stream_buf. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38938544-bb"></a><span class="identifier">pipe</span><span class="special">(</span><a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38940672-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span> <a name="idp38942960-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a reference to the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&</span> <a name="idp38944400-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get a const reference to the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_opstream.html#boost.process.basic_opstream.pipe_type">pipe_type</a> <span class="special">&&</span> <a name="idp38946272-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a rvalue reference to the pipe. Qualified as rvalue. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="basic_ipstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="basic_pstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_pipe.html b/doc/html/boost/process/basic_pipe.html new file mode 100644 index 0000000000..aa76031188 --- /dev/null +++ b/doc/html/boost/process/basic_pipe.html @@ -0,0 +1,164 @@ +<!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>Class template basic_pipe</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.pipe_hpp" title="Header <boost/process/pipe.hpp>"> +<link rel="prev" href="std_err.html" title="Global std_err"> +<link rel="next" href="basic_pipebuf.html" title="Struct template basic_pipebuf"> +</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="std_err.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="basic_pipebuf.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_pipe"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template basic_pipe</span></h2> +<p>boost::process::basic_pipe</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: <<a class="link" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header <boost/process/pipe.hpp>">boost/process/pipe.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> +<span class="keyword">class</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">CharT</span> <a name="boost.process.basic_pipe.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span> <a name="boost.process.basic_pipe.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">int_type</span> <a name="boost.process.basic_pipe.int_type"></a><span class="identifier">int_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">pos_type</span> <a name="boost.process.basic_pipe.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">off_type</span> <a name="boost.process.basic_pipe.off_type"></a><span class="identifier">off_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.basic_pipe.native_handle"></a><span class="identifier">native_handle</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_pipe.html#boost.process.basic_pipeconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_pipe.html#idp38835536-bb"><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="basic_pipe.html#idp38836144-bb"><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipe.html#idp38837696-bb"><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipe.html#idp38840144-bb"><span class="identifier">basic_pipe</span></a><span class="special">(</span><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a class="link" href="basic_pipe.html#idp38841840-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a class="link" href="basic_pipe.html#idp38844848-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipe.html#idp38847104-bb"><span class="special">~</span><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_pipe.html#idp38820432-bb">public member functions</a></span> + <span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idp38820992-bb"><span class="identifier">native_source</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idp38822544-bb"><span class="identifier">native_sink</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_pipe.html#idp38824096-bb"><span class="identifier">assign_source</span></a><span class="special">(</span><span class="identifier">native_handle</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_pipe.html#idp38826064-bb"><span class="identifier">assign_sink</span></a><span class="special">(</span><span class="identifier">native_handle</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">int_type</span> <a class="link" href="basic_pipe.html#idp38828032-bb"><span class="identifier">write</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">int_type</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">int_type</span> <a class="link" href="basic_pipe.html#idp38830560-bb"><span class="identifier">read</span></a><span class="special">(</span><span class="identifier">char_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">int_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_pipe.html#idp38833088-bb"><span class="identifier">is_open</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_pipe.html#idp38834240-bb"><span class="identifier">close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp436972304"></a><h2>Description</h2> +<p>Class implementation of a pipe. </p> +<div class="refsect2"> +<a name="idp436973024"></a><h3> +<a name="boost.process.basic_pipeconstruct-copy-destruct"></a><code class="computeroutput">basic_pipe</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idp38835536-bb"></a><span class="identifier">basic_pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default construct the pipe. Will be opened. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp38836144-bb"></a><span class="identifier">basic_pipe</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span></pre>Construct a named pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38837696-bb"></a><span class="identifier">basic_pipe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<p>Copy construct the pipe. </p> +<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>Duplicated the handles. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38840144-bb"></a><span class="identifier">basic_pipe</span><span class="special">(</span><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre> +<p>Move construct the pipe. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a name="idp38841840-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<p>Copy assign the pipe. </p> +<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>Duplicated the handles. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a name="idp38844848-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre> +<p>Move assign the pipe. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38847104-bb"></a><span class="special">~</span><span class="identifier">basic_pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Destructor closes the handles. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp437019456"></a><h3> +<a name="idp38820432-bb"></a><code class="computeroutput">basic_pipe</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">native_handle</span> <a name="idp38820992-bb"></a><span class="identifier">native_source</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the native handle of the source. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">native_handle</span> <a name="idp38822544-bb"></a><span class="identifier">native_sink</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the native handle of the sink. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38824096-bb"></a><span class="identifier">assign_source</span><span class="special">(</span><span class="identifier">native_handle</span> h<span class="special">)</span><span class="special">;</span></pre> +<p>Assign a new value to the source </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38826064-bb"></a><span class="identifier">assign_sink</span><span class="special">(</span><span class="identifier">native_handle</span> h<span class="special">)</span><span class="special">;</span></pre> +<p>Assign a new value to the sink </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">int_type</span> <a name="idp38828032-bb"></a><span class="identifier">write</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> data<span class="special">,</span> <span class="identifier">int_type</span> count<span class="special">)</span><span class="special">;</span></pre>Write data to the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">int_type</span> <a name="idp38830560-bb"></a><span class="identifier">read</span><span class="special">(</span><span class="identifier">char_type</span> <span class="special">*</span> data<span class="special">,</span> <span class="identifier">int_type</span> count<span class="special">)</span><span class="special">;</span></pre>Read data from the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38833088-bb"></a><span class="identifier">is_open</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Check if the pipe is open. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38834240-bb"></a><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Close the pipe. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="std_err.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="basic_pipebuf.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_pipebuf.html b/doc/html/boost/process/basic_pipebuf.html new file mode 100644 index 0000000000..a7303f4adb --- /dev/null +++ b/doc/html/boost/process/basic_pipebuf.html @@ -0,0 +1,144 @@ +<!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>Struct template basic_pipebuf</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.pipe_hpp" title="Header <boost/process/pipe.hpp>"> +<link rel="prev" href="basic_pipe.html" title="Class template basic_pipe"> +<link rel="next" href="basic_ipstream.html" title="Class template basic_ipstream"> +</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="basic_pipe.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="basic_ipstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_pipebuf"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template basic_pipebuf</span></h2> +<p>boost::process::basic_pipebuf</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: <<a class="link" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header <boost/process/pipe.hpp>">boost/process/pipe.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_streambuf</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <a name="boost.process.basic_pipebuf.pipe_type"></a><span class="identifier">pipe_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">CharT</span> <a name="boost.process.basic_pipebuf.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span> <a name="boost.process.basic_pipebuf.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">int_type</span> <a name="boost.process.basic_pipebuf.int_type"></a><span class="identifier">int_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">pos_type</span> <a name="boost.process.basic_pipebuf.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">off_type</span> <a name="boost.process.basic_pipebuf.off_type"></a><span class="identifier">off_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebufconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_pipebuf.html#idp38871888-bb"><span class="identifier">basic_pipebuf</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html#idp38872496-bb"><span class="identifier">basic_pipebuf</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html#idp38874480-bb"><span class="identifier">basic_pipebuf</span></a><span class="special">(</span><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html#idp38876304-bb"><span class="identifier">basic_pipebuf</span></a><span class="special">(</span><a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html#idp38877872-bb"><span class="identifier">basic_pipebuf</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span> <a class="link" href="basic_pipebuf.html#idp38879584-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span> <a class="link" href="basic_pipebuf.html#idp38882144-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span> <a class="link" href="basic_pipebuf.html#idp38884544-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span> <a class="link" href="basic_pipebuf.html#idp38886672-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_pipebuf.html#idp38857440-bb">public member functions</a></span> + <span class="identifier">int_type</span> <a class="link" href="basic_pipebuf.html#idp38858000-bb"><span class="identifier">overflow</span></a><span class="special">(</span><span class="identifier">int_type</span> <span class="special">=</span> <span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">eof</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">int</span> <a class="link" href="basic_pipebuf.html#idp38860160-bb"><span class="identifier">sync</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">int_type</span> <a class="link" href="basic_pipebuf.html#idp38861344-bb"><span class="identifier">underflow</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_pipebuf.html#idp38862528-bb"><span class="identifier">pipe</span></a><span class="special">(</span><a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_pipebuf.html#idp38864656-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span> <a class="link" href="basic_pipebuf.html#idp38866944-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span> <a class="link" href="basic_pipebuf.html#idp38868384-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&&</span> <a class="link" href="basic_pipebuf.html#idp38870256-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_pipebuf.html#idp38888960-bb">private member functions</a></span> + <span class="keyword">bool</span> <a class="link" href="basic_pipebuf.html#idp38889536-bb"><span class="identifier">_write_impl</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// public data members</span> + <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">int</span> <span class="identifier">default_buffer_size</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp437220704"></a><h2>Description</h2> +<p>Implementation of the stream buffer for a pipe. </p> +<div class="refsect2"> +<a name="idp437221440"></a><h3> +<a name="boost.process.basic_pipebufconstruct-copy-destruct"></a><code class="computeroutput">basic_pipebuf</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idp38871888-bb"></a><span class="identifier">basic_pipebuf</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor, will also construct the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38872496-bb"></a><span class="identifier">basic_pipebuf</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Copy Constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38874480-bb"></a><span class="identifier">basic_pipebuf</span><span class="special">(</span><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move Constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38876304-bb"></a><span class="identifier">basic_pipebuf</span><span class="special">(</span><a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Move construct from a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38877872-bb"></a><span class="identifier">basic_pipebuf</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Construct from a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span> <a name="idp38879584-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy assign. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span> <a name="idp38882144-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move assign. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span> <a name="idp38884544-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Move assign a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a> <span class="special">&</span> <a name="idp38886672-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Copy assign a pipe. </li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp437285680"></a><h3> +<a name="idp38857440-bb"></a><code class="computeroutput">basic_pipebuf</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">int_type</span> <a name="idp38858000-bb"></a><span class="identifier">overflow</span><span class="special">(</span><span class="identifier">int_type</span> ch <span class="special">=</span> <span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">eof</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Writes characters to the associated output sequence from the put area. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">int</span> <a name="idp38860160-bb"></a><span class="identifier">sync</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Synchronizes the buffers with the associated character sequence. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">int_type</span> <a name="idp38861344-bb"></a><span class="identifier">underflow</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Reads characters from the associated input sequence to the get area. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38862528-bb"></a><span class="identifier">pipe</span><span class="special">(</span><a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38864656-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span> <a name="idp38866944-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a reference to the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&</span> <a name="idp38868384-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get a const reference to the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipebuf.html#boost.process.basic_pipebuf.pipe_type">pipe_type</a> <span class="special">&&</span> <a name="idp38870256-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a rvalue reference to the pipe. Qualified as rvalue. </li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp437335296"></a><h3> +<a name="idp38888960-bb"></a><code class="computeroutput">basic_pipebuf</code> private member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp38889536-bb"></a><span class="identifier">_write_impl</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="basic_pipe.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="basic_ipstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/basic_pstream.html b/doc/html/boost/process/basic_pstream.html new file mode 100644 index 0000000000..45577407e1 --- /dev/null +++ b/doc/html/boost/process/basic_pstream.html @@ -0,0 +1,128 @@ +<!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>Class template basic_pstream</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.pipe_hpp" title="Header <boost/process/pipe.hpp>"> +<link rel="prev" href="basic_opstream.html" title="Class template basic_opstream"> +<link rel="next" href="posix/fd.html" title="Global fd"> +</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="basic_opstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="posix/fd.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.basic_pstream"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template basic_pstream</span></h2> +<p>boost::process::basic_pstream</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: <<a class="link" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header <boost/process/pipe.hpp>">boost/process/pipe.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> +<span class="keyword">class</span> <a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_iostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <a name="boost.process.basic_pstream.pipe_type"></a><span class="identifier">pipe_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">CharT</span> <a name="boost.process.basic_pstream.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span> <a name="boost.process.basic_pstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">int_type</span> <a name="boost.process.basic_pstream.int_type"></a><span class="identifier">int_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">pos_type</span> <a name="boost.process.basic_pstream.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">off_type</span> <a name="boost.process.basic_pstream.off_type"></a><span class="identifier">off_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_pstream.html#boost.process.basic_pstreamconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_pstream.html#idp38985136-bb"><span class="identifier">basic_pstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pstream.html#idp38985712-bb"><span class="identifier">basic_pstream</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> + <a class="link" href="basic_pstream.html#idp38987696-bb"><span class="identifier">basic_pstream</span></a><span class="special">(</span><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="basic_pstream.html#idp38989520-bb"><span class="identifier">basic_pstream</span></a><span class="special">(</span><a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pstream.html#idp38991088-bb"><span class="identifier">basic_pstream</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span> <a class="link" href="basic_pstream.html#idp38992816-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> + <a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span> <a class="link" href="basic_pstream.html#idp38995376-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span> <a class="link" href="basic_pstream.html#idp38997776-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span> <a class="link" href="basic_pstream.html#idp38999920-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_pstream.html#idp38973488-bb">public member functions</a></span> + <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_pstream.html#idp38974048-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_pstream.html#idp38975776-bb"><span class="identifier">pipe</span></a><span class="special">(</span><a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_pstream.html#idp38977904-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span> <a class="link" href="basic_pstream.html#idp38980192-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span> <a class="link" href="basic_pstream.html#idp38981632-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&&</span> <a class="link" href="basic_pstream.html#idp38983504-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp437973296"></a><h2>Description</h2> +<p>Implementation of a read-write pipe stream. </p> +<div class="refsect2"> +<a name="idp437974032"></a><h3> +<a name="boost.process.basic_pstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_pstream</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idp38985136-bb"></a><span class="identifier">basic_pstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38985712-bb"></a><span class="identifier">basic_pstream</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38987696-bb"></a><span class="identifier">basic_pstream</span><span class="special">(</span><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38989520-bb"></a><span class="identifier">basic_pstream</span><span class="special">(</span><a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Move construct from a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38991088-bb"></a><span class="identifier">basic_pstream</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Copy construct from a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span> <a name="idp38992816-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy assignment. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span> <a name="idp38995376-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move assignment. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span> <a name="idp38997776-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Move assignment of a pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a> <span class="special">&</span> <a name="idp38999920-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Copy assignment of a pipe. </li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp438038256"></a><h3> +<a name="idp38973488-bb"></a><code class="computeroutput">basic_pstream</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">*</span> <a name="idp38974048-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get access to the underlying stream_buf. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38975776-bb"></a><span class="identifier">pipe</span><span class="special">(</span><a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38977904-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span> <a name="idp38980192-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a reference to the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&</span> <a name="idp38981632-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get a const reference to the pipe. </li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_pstream.html#boost.process.basic_pstream.pipe_type">pipe_type</a> <span class="special">&&</span> <a name="idp38983504-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a rvalue reference to the pipe. Qualified as rvalue. </li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="basic_opstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_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="posix/fd.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/child.html b/doc/html/boost/process/child.html new file mode 100644 index 0000000000..2d9a080bf6 --- /dev/null +++ b/doc/html/boost/process/child.html @@ -0,0 +1,272 @@ +<!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>Class child</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.child_hpp" title="Header <boost/process/child.hpp>"> +<link rel="prev" href="async_system.html" title="Function template async_system"> +<link rel="next" href="cmd.html" title="Global cmd"> +</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="async_system.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.child_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="cmd.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.child"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class child</span></h2> +<p>boost::process::child</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: <<a class="link" href="../../process/reference.html#header.boost.process.child_hpp" title="Header <boost/process/child.hpp>">boost/process/child.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="child.html#boost.process.childconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">explicit</span> <a class="link" href="child.html#idp38158272-bb"><span class="identifier">child</span></a><span class="special">(</span><span class="identifier">pid_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="child.html#idp38160544-bb"><span class="identifier">child</span></a><span class="special">(</span><a class="link" href="child.html" title="Class child">child</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> <span class="keyword">explicit</span> <a class="link" href="child.html#idp38162064-bb"><span class="identifier">child</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="special">&&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="child.html#idp38164720-bb"><span class="identifier">child</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span> <a class="link" href="child.html#idp38165600-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="child.html" title="Class child">child</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="child.html#idp38167632-bb"><span class="special">~</span><span class="identifier">child</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="child.html#idp38118352-bb">private member functions</a></span> + <span class="keyword">void</span> <a class="link" href="child.html#idp38118848-bb"><span class="identifier">detach</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="child.html#idp38120064-bb"><span class="identifier">join</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38121312-bb"><span class="identifier">joinable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">native_handle_t</span> <a class="link" href="child.html#idp38122448-bb"><span class="identifier">native_handle</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">int</span> <a class="link" href="child.html#idp38123824-bb"><span class="identifier">exit_code</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">pid_t</span> <a class="link" href="child.html#idp38125328-bb"><span class="identifier">id</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38126704-bb"><span class="identifier">running</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38127840-bb"><span class="identifier">running</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="child.html#idp38130000-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="child.html#idp38131136-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38133296-bb"><span class="identifier">wait_for</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special"><</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38136768-bb"><span class="identifier">wait_for</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special"><</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</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">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38139552-bb"><span class="identifier">wait_until</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special"><</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38143024-bb"><span class="identifier">wait_until</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special"><</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</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">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38145808-bb"><span class="identifier">valid</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="child.html#idp38147824-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38149440-bb"><span class="identifier">in_group</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="child.html#idp38150896-bb"><span class="identifier">in_group</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="child.html#idp38153056-bb"><span class="identifier">terminate</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="child.html#idp38155984-bb"><span class="identifier">terminate</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp432828192"></a><h2>Description</h2> +<p>The main class to hold a child process. It is simliar to <a href="http://en.cppreference.com/w/cpp/thread/thread" target="_top">std::thread</a>, in that it has a join and detach function.</p> +<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 destructor will call terminate on the process if not joined or detached without any warning. </p></td></tr> +</table></div> +<p> +</p> +<div class="refsect2"> +<a name="idp432830480"></a><h3> +<a name="boost.process.childconstruct-copy-destruct"></a><code class="computeroutput">child</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp38158272-bb"></a><span class="identifier">child</span><span class="special">(</span><span class="identifier">pid_t</span> <span class="special">&</span> pid<span class="special">)</span><span class="special">;</span></pre> +<p>Construct the child from a pid.</p> +<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>There is no guarantee that this will work. The process need the right access rights, which are very platform specific. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38160544-bb"></a><span class="identifier">child</span><span class="special">(</span><a class="link" href="child.html" title="Class child">child</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre> +<p>Move-Constructor. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> <span class="keyword">explicit</span> <a name="idp38162064-bb"></a><span class="identifier">child</span><span class="special">(</span><span class="identifier">Args</span> <span class="special">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre> +<p>Construct a child from a property list and launch it The standard version is to create a subprocess, which will spawn the process. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38164720-bb"></a><span class="identifier">child</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre> +<p>Construct an empty child. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span> <a name="idp38165600-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="child.html" title="Class child">child</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre> +<p>Move assign. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38167632-bb"></a><span class="special">~</span><span class="identifier">child</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Destructor. </p> +<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>Will call terminate (without warning) when the child was neither joined nor detached. </p></td></tr> +</table></div> +<p> +</p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp432872336"></a><h3> +<a name="idp38118352-bb"></a><code class="computeroutput">child</code> private member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38118848-bb"></a><span class="identifier">detach</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Detach the child, i.e. let it run after this handle dies. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38120064-bb"></a><span class="identifier">join</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Join the child. This just calls wait, but that way the naming is similar to std::thread </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38121312-bb"></a><span class="identifier">joinable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Check if the child is joinable. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">native_handle_t</span> <a name="idp38122448-bb"></a><span class="identifier">native_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the native handle for the child process. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">int</span> <a name="idp38123824-bb"></a><span class="identifier">exit_code</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the exit_code. The return value is without any meaning if the child wasn't waited for or if it was terminated. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">pid_t</span> <a name="idp38125328-bb"></a><span class="identifier">id</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the Process Identifier. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38126704-bb"></a><span class="identifier">running</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Check if the child process is running. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38127840-bb"></a><span class="identifier">running</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38130000-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Wait for the child process to exit. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38131136-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">></span> + <span class="keyword">bool</span> <a name="idp38133296-bb"></a><span class="identifier">wait_for</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special"><</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">></span> <span class="special">&</span> rel_time<span class="special">)</span><span class="special">;</span></pre> +<p>Wait for the child process to exit for a period of time. +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>True if child exited while waiting. </p></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38136768-bb"></a><span class="identifier">wait_for</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special"><</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">></span> <span class="special">&</span> rel_time<span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">></span> + <span class="keyword">bool</span> <a name="idp38139552-bb"></a><span class="identifier">wait_until</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special"><</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">></span> <span class="special">&</span> timeout_time<span class="special">)</span><span class="special">;</span></pre> +<p>Wait for the child process to exit until a point in time. +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>True if child exited while waiting. </p></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38143024-bb"></a><span class="identifier">wait_until</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special"><</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">></span> <span class="special">&</span> timeout_time<span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38145808-bb"></a><span class="identifier">valid</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Check if this handle holds a child process. </p> +<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>That does not mean, that the process is still running. It only means, that the handle does or did exist. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp38147824-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Same as valid, for convenience. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38149440-bb"></a><span class="identifier">in_group</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Check if the the chlid process is in any process group. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38150896-bb"></a><span class="identifier">in_group</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38153056-bb"></a><span class="identifier">terminate</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Terminate the child process.</p> +<p>This function will cause the child process to unconditionally and immediately exit. It is implement with <a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/kill.html" target="_top">SIGKILL</a> on posix and <a href="https://technet.microsoft.com/en-us/library/ms686714.aspx" target="_top">TerminateProcess</a> on windows. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38155984-bb"></a><span class="identifier">terminate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="async_system.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.child_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="cmd.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/close.html b/doc/html/boost/process/close.html new file mode 100644 index 0000000000..e4b6ea903e --- /dev/null +++ b/doc/html/boost/process/close.html @@ -0,0 +1,51 @@ +<!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 close</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.io_hpp" title="Header <boost/process/io.hpp>"> +<link rel="prev" href="group.html" title="Class group"> +<link rel="next" href="null.html" title="Global null"> +</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="group.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="null.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.close"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global close</span></h2> +<p>boost::process::close — This constant is a utility to allow syntax like <code class="computeroutput">std_out > close</code> for closing I/O streams. </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: <<a class="link" href="../../process/reference.html#header.boost.process.io_hpp" title="Header <boost/process/io.hpp>">boost/process/io.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> close<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="group.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="null.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/cmd.html b/doc/html/boost/process/cmd.html new file mode 100644 index 0000000000..a5bdf06de9 --- /dev/null +++ b/doc/html/boost/process/cmd.html @@ -0,0 +1,61 @@ +<!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 cmd</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.cmd_hpp" title="Header <boost/process/cmd.hpp>"> +<link rel="prev" href="child.html" title="Class child"> +<link rel="next" href="env.html" title="Global env"> +</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="child.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.cmd_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="env.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.cmd"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global cmd</span></h2> +<p>boost::process::cmd</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: <<a class="link" href="../../process/reference.html#header.boost.process.cmd_hpp" title="Header <boost/process/cmd.hpp>">boost/process/cmd.hpp</a>> + +</span><span class="keyword">static</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> cmd<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp433053408"></a><h2>Description</h2> +<p>The cmd property allows to explicitly set commands for the execution.</p> +<p>The overload form applies when only one string is passed to a launching function. The string will be internally parsed and split at spaces.</p> +<p>The following expressions are valid, with <code class="computeroutput">value</code> being either a C-String or a <code class="computeroutput">std::basic_string</code> with <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>.</p> +<pre class="programlisting"><span class="identifier">cmd</span><span class="special">=</span><span class="string">"value"</span><span class="special">;</span> +<span class="identifier">cmd</span><span class="special">(</span><span class="identifier">value</span><span class="special">)</span><span class="special">;</span> +</pre> +<p>The property can only be used for assignments. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="child.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.cmd_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="env.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/env.html b/doc/html/boost/process/env.html new file mode 100644 index 0000000000..c948529676 --- /dev/null +++ b/doc/html/boost/process/env.html @@ -0,0 +1,264 @@ +<!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 env</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.env_hpp" title="Header <boost/process/env.hpp>"> +<link rel="prev" href="cmd.html" title="Global cmd"> +<link rel="next" href="basic_environment.html" title="Class template basic_environment"> +</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="cmd.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.env_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="basic_environment.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.env"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global env</span></h2> +<p>boost::process::env</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: <<a class="link" href="../../process/reference.html#header.boost.process.env_hpp" title="Header <boost/process/env.hpp>">boost/process/env.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> env<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp433083104"></a><h2>Description</h2> +<p>The <code class="computeroutput">env</code> property provides a functional way to modify the environment used by the child process. If none is passed the environment is inherited from the father process. Appending means that the environment will be interpreted as a ';' or ':' seperated list as used in <code class="computeroutput">PATH</code>.</p> +<p>On both <code class="computeroutput">posix</code> and <code class="computeroutput">windows</code> the environment variables can be lists of strings, seperated by ';'. This is typically used for the <code class="computeroutput">PATH</code> variable.</p> +<p>By default the environment will be inherited from the launching process, which is also true if environment are modified with this initializer.</p> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="namespaceboost_1_1process_1env_details"></a>Details</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt><span class="sect2"><a href="env.html#namespaceboost_1_1process_1env_operations">Operations</a></span></dt> +<dt><span class="sect2"><a href="env.html#namespaceboost_1_1process_1env_example">Example</a></span></dt> +</dl></div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1env_operations"></a>Operations</h3></div></div></div> +<div class="toc"><dl class="toc"> +<dt><span class="sect3"><a href="env.html#namespaceboost_1_1process_1env_set_var">Setting variables</a></span></dt> +<dt><span class="sect3"><a href="env.html#namespaceboost_1_1process_1env_append_var">Append variables</a></span></dt> +<dt><span class="sect3"><a href="env.html#namespaceboost_1_1process_1env_reset">Reset variables</a></span></dt> +<dt><span class="sect3"><a href="env.html#namespaceboost_1_1process_1env_init">Initialize the environment</a></span></dt> +</dl></div> +<div class="sect3"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="namespaceboost_1_1process_1env_set_var"></a>Setting variables</h4></div></div></div> +<div class="toc"><dl class="toc"> +<dt><span class="sect4"><a href="env.html#namespaceboost_1_1process_1id">id</a></span></dt> +<dt><span class="sect4"><a href="env.html#namespaceboost_1_1process_1env_set_var_value">value</a></span></dt> +</dl></div> +<p>To set a variable <code class="computeroutput">id</code> the value <code class="computeroutput">value</code> the following syntax can be used.</p> +<pre class="programlisting"><span class="identifier">env</span><span class="special">[</span><span class="identifier">id</span><span class="special">]</span> <span class="special">=</span> <span class="identifier">value</span><span class="special">;</span> +<span class="identifier">env</span><span class="special">(</span><span class="identifier">id</span><span class="special">,</span> <span class="identifier">value</span><span class="special">)</span><span class="special">;</span> +</pre> +<p><code class="computeroutput">std::initializer_list</code> is among the allowed types, so the following syntax is also possible.</p> +<pre class="programlisting"><span class="identifier">env</span><span class="special">[</span><span class="identifier">id</span><span class="special">]</span> <span class="special">=</span> <span class="special">{</span><span class="identifier">value1</span><span class="special">,</span> <span class="identifier">value2</span><span class="special">}</span><span class="special">;</span> +<span class="identifier">env</span><span class="special">(</span><span class="identifier">id</span><span class="special">,</span> <span class="special">{</span><span class="identifier">value1</span><span class="special">,</span> <span class="identifier">value2</span><span class="special">}</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>Creates the variable if it does not exist.</p></td></tr> +</table></div> +<p> +The following lists contain possible value types, with <code class="computeroutput">char_type</code> being either <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code> for both <code class="computeroutput">id</code> and <code class="computeroutput">value</code>.</p> +<div class="sect4"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="namespaceboost_1_1process_1id"></a>id</h5></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type *</code></p></li> +</ul></div> +<p> +</p> +</div> +<div class="sect4"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="namespaceboost_1_1process_1env_set_var_value"></a>value</h5></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type *</code></p></li> +<li class="listitem"><p><code class="computeroutput">std::initializer_list<const char_type *></code></p></li> +<li class="listitem"><p><code class="computeroutput">std::vector<std::basic_string<char_type>></code></p></li> +</ul></div> +<p> +</p> +<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>Using <code class="computeroutput">std::vector</code> or <code class="computeroutput">std::initializer_list</code></p></td></tr> +</table></div> +<p> +</p> +</div> +</div> +<div class="sect3"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="namespaceboost_1_1process_1env_append_var"></a>Append variables</h4></div></div></div> +<div class="toc"><dl class="toc"> +<dt><span class="sect4"><a href="env.html#namespaceboost_1_1process_1env_append_var_id">id</a></span></dt> +<dt><span class="sect4"><a href="env.html#namespaceboost_1_1process_1env_append_var_value">value</a></span></dt> +</dl></div> +<p>Appending means, that a variable will be interpreted as a To append a variable <code class="computeroutput">id</code> the value <code class="computeroutput">value</code> the following syntax can be used:</p> +<pre class="programlisting"><span class="identifier">env</span><span class="special">[</span><span class="identifier">id</span><span class="special">]</span> <span class="special">+=</span> <span class="identifier">value</span><span class="special">;</span> +</pre> +<p><code class="computeroutput">std::initializer_list</code> is among the allowed types, so the following syntax is also possible.</p> +<pre class="programlisting"><span class="identifier">env</span><span class="special">[</span><span class="identifier">id</span><span class="special">]</span> <span class="special">+=</span> <span class="special">{</span><span class="identifier">value1</span><span class="special">,</span> <span class="identifier">value2</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>Creates the variable if it does not exist.</p></td></tr> +</table></div> +<p> +The following lists contain possible value types, with <code class="computeroutput">char_type</code> being either <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code> for both <code class="computeroutput">id</code> and <code class="computeroutput">value</code>.</p> +<div class="sect4"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="namespaceboost_1_1process_1env_append_var_id"></a>id</h5></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type *</code></p></li> +</ul></div> +<p> +</p> +</div> +<div class="sect4"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="namespaceboost_1_1process_1env_append_var_value"></a>value</h5></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type *</code></p></li> +<li class="listitem"><p><code class="computeroutput">std::initializer_list<const char_type *></code></p></li> +<li class="listitem"><p><code class="computeroutput">std::vector<std::basic_string<char_type>></code></p></li> +</ul></div> +<p> +</p> +</div> +</div> +<div class="sect3"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="namespaceboost_1_1process_1env_reset"></a>Reset variables</h4></div></div></div> +<div class="toc"><dl class="toc"><dt><span class="sect4"><a href="env.html#namespaceboost_1_1process_1env_reset_var_id">id</a></span></dt></dl></div> +<p>Reseting signle variables can be done in the following way:</p> +<pre class="programlisting"><span class="identifier">env</span><span class="special">[</span><span class="identifier">id</span><span class="special">]</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">none</span><span class="special">;</span> +<span class="identifier">env</span><span class="special">(</span><span class="identifier">id</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">none</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>This does not set the value empty, but removes it from the list.</p></td></tr> +</table></div> +<p> +The following lists contain possible value types, with <code class="computeroutput">char_type</code> being either <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>:</p> +<div class="sect4"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="namespaceboost_1_1process_1env_reset_var_id"></a>id</h5></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type *</code></p></li> +</ul></div> +<p> +</p> +</div> +</div> +<div class="sect3"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="namespaceboost_1_1process_1env_init"></a>Initialize the environment</h4></div></div></div> +<div class="toc"><dl class="toc"> +<dt><span class="sect4"><a href="env.html#namespaceboost_1_1process_1env_init_var_id">id</a></span></dt> +<dt><span class="sect4"><a href="env.html#namespaceboost_1_1process_1env_init_var_value">value</a></span></dt> +</dl></div> +<p>The whole environment can be initialized from an object of type <a class="link" href="../../process/reference.html#boost.process.environment">boost::process::environment</a> </p> +<pre class="programlisting"><span class="identifier">env</span><span class="special">=</span><span class="identifier">env</span><span class="special">;</span> +<span class="identifier">env</span><span class="special">(</span><span class="identifier">env</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 passed <code class="computeroutput">environment</code> can also be default-constructed to get an empty environment.</p></td></tr> +</table></div> +<p> +</p> +<div class="sect4"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="namespaceboost_1_1process_1env_init_var_id"></a>id</h5></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type *</code></p></li> +</ul></div> +<p> +</p> +</div> +<div class="sect4"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="namespaceboost_1_1process_1env_init_var_value"></a>value</h5></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="computeroutput"><a class="link" href="basic_environment.html" title="Class template basic_environment">boost::process::basic_environment</a><char_type></code></p></li></ul></div> +<p> +</p> +</div> +</div> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1env_example"></a>Example</h3></div></div></div> +<pre class="programlisting"><span class="identifier">spawn</span><span class="special">(</span><span class="string">"b2"</span><span class="special">,</span> <span class="identifier">env</span><span class="special">[</span><span class="string">"PATH"</span><span class="special">]</span><span class="special">+=</span><span class="string">"F:/boost"</span><span class="special">,</span> <span class="identifier">env</span><span class="special">[</span><span class="string">"SOME_VAR"</span><span class="special">]</span><span class="special">=</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">none</span><span class="special">,</span> <span class="identifier">env</span><span class="special">[</span><span class="string">"NEW_VAR"</span><span class="special">]</span><span class="special">=</span><span class="string">"VALUE"</span><span class="special">)</span><span class="special">;</span> +</pre> +<p>If the overload style should be done by passing an instance of <a class="link" href="../../process/reference.html#boost.process.environment">boost::process::environment</a> the above example would look like this.</p> +<pre class="programlisting"><span class="identifier">environment</span> <span class="identifier">e</span> <span class="special">=</span> <span class="identifier">this_process</span><span class="special">::</span><span class="identifier">environment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">e</span><span class="special">[</span><span class="string">"PATH"</span><span class="special">]</span> <span class="special">+=</span> <span class="string">"F:/boost"</span><span class="special">;</span> +<span class="identifier">e</span><span class="special">.</span><span class="identifier">erase</span><span class="special">(</span><span class="string">"SOME_VAR"</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">e</span><span class="special">[</span><span class="string">"NEW_VAR"</span><span class="special">]</span> <span class="special">=</span> <span class="string">"VALUE"</span><span class="special">;</span> +<span class="identifier">spawn</span><span class="special">(</span><span class="string">"b2"</span><span class="special">,</span> <span class="identifier">e</span><span class="special">)</span><span class="special">;</span> +</pre> +<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>Passing an empty environment will cause undefined behaviour. </p></td></tr> +</table></div> +<p> +</p> +</div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="cmd.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.env_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="basic_environment.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/error.html b/doc/html/boost/process/error.html new file mode 100644 index 0000000000..84fc8481f2 --- /dev/null +++ b/doc/html/boost/process/error.html @@ -0,0 +1,63 @@ +<!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 error</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.error_hpp" title="Header <boost/process/error.hpp>"> +<link rel="prev" href="throw_on_error.html" title="Global throw_on_error"> +<link rel="next" href="error_ref.html" title="Global error_ref"> +</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="throw_on_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="error_ref.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global error</span></h2> +<p>boost::process::error</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: <<a class="link" href="../../process/reference.html#header.boost.process.error_hpp" title="Header <boost/process/error.hpp>">boost/process/error.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> error<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp434875120"></a><h2>Description</h2> +<p>The error property will set the executor to handle any errors by setting an <a href="http://en.cppreference.com/w/cpp/error/error_code" target="_top">std::error_code</a>.</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">;</span> +<span class="identifier">system</span><span class="special">(</span><span class="string">"gcc"</span><span class="special">,</span> <span class="identifier">error</span><span class="special">(</span><span class="identifier">ec</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> +</pre> +<p>The following syntax is valid:</p> +<pre class="programlisting"><span class="identifier">error</span><span class="special">(</span><span class="identifier">ec</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">error</span><span class="special">=</span><span class="identifier">ec</span><span class="special">;</span> +</pre> +<p>The overload version is achieved by just passing an object of <a href="http://en.cppreference.com/w/cpp/error/error_code" target="_top">std::error_code</a> to the function. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="throw_on_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="error_ref.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/error_code.html b/doc/html/boost/process/error_code.html new file mode 100644 index 0000000000..a56d2f4c78 --- /dev/null +++ b/doc/html/boost/process/error_code.html @@ -0,0 +1,51 @@ +<!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 error_code</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.error_hpp" title="Header <boost/process/error.hpp>"> +<link rel="prev" href="error_ref.html" title="Global error_ref"> +<link rel="next" href="process_error.html" title="Struct process_error"> +</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="error_ref.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="process_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.error_code"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global error_code</span></h2> +<p>boost::process::error_code — Alias for <a class="link" href="error.html" title="Global error">error</a> . </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: <<a class="link" href="../../process/reference.html#header.boost.process.error_hpp" title="Header <boost/process/error.hpp>">boost/process/error.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> error_code<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="error_ref.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="process_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/error_ref.html b/doc/html/boost/process/error_ref.html new file mode 100644 index 0000000000..94b3393b3b --- /dev/null +++ b/doc/html/boost/process/error_ref.html @@ -0,0 +1,51 @@ +<!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 error_ref</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.error_hpp" title="Header <boost/process/error.hpp>"> +<link rel="prev" href="error.html" title="Global error"> +<link rel="next" href="error_code.html" title="Global error_code"> +</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="error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="error_code.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.error_ref"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global error_ref</span></h2> +<p>boost::process::error_ref — Alias for <a class="link" href="error.html" title="Global error">error</a> . </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: <<a class="link" href="../../process/reference.html#header.boost.process.error_hpp" title="Header <boost/process/error.hpp>">boost/process/error.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> error_ref<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="error_code.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/exe.html b/doc/html/boost/process/exe.html new file mode 100644 index 0000000000..5a9c8f5b92 --- /dev/null +++ b/doc/html/boost/process/exe.html @@ -0,0 +1,61 @@ +<!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 exe</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.exe_hpp" title="Header <boost/process/exe.hpp>"> +<link rel="prev" href="process_error.html" title="Struct process_error"> +<link rel="next" href="extend/handler.html" title="Struct handler"> +</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="process_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.exe_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="extend/handler.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.exe"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global exe</span></h2> +<p>boost::process::exe</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: <<a class="link" href="../../process/reference.html#header.boost.process.exe_hpp" title="Header <boost/process/exe.hpp>">boost/process/exe.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> exe<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp434941520"></a><h2>Description</h2> +<p>The exe property allows to explicitly set the executable.</p> +<p>The overload form applies when to the first, when several strings are passed to a launching function.</p> +<p>The following expressions are valid, with <code class="computeroutput">value</code> being either a C-String or a <code class="computeroutput">std::basic_string</code> with <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code> or a <code class="computeroutput">boost::filesystem::path</code>.</p> +<pre class="programlisting"><span class="identifier">exe</span><span class="special">=</span><span class="string">"value"</span><span class="special">;</span> +<span class="identifier">exe</span><span class="special">(</span><span class="identifier">value</span><span class="special">)</span><span class="special">;</span> +</pre> +<p>The property can only be used for assignments. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="process_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.exe_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="extend/handler.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/async_handler.html b/doc/html/boost/process/extend/async_handler.html new file mode 100644 index 0000000000..a79fb2bcb2 --- /dev/null +++ b/doc/html/boost/process/extend/async_handler.html @@ -0,0 +1,81 @@ +<!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>Struct async_handler</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="require_io_service.html" title="Struct require_io_service"> +<link rel="next" href="posix_executor.html" title="Struct template posix_executor"> +</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="require_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="posix_executor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.async_handler"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct async_handler</span></h2> +<p>boost::process::extend::async_handler</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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span> +<span class="keyword">struct</span> <a class="link" href="async_handler.html" title="Struct async_handler">async_handler</a> <span class="special">:</span> <span class="keyword">public</span> boost::process::extend::handler, + <span class="keyword">public</span> boost::process::extend::require_io_service +<span class="special">{</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435195984"></a><h2>Description</h2> +<p>Inheriting this class will tell the launching function, that an event handler shall be invoked when the process exits. This automatically does also inherit <a class="link" href="require_io_service.html" title="Struct require_io_service">require_io_service</a>.</p> +<p>You must add the following function to your implementation:</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Executor</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">function</span><span class="special"><</span><span class="keyword">void</span><span class="special">(</span><span class="keyword">int</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">&</span><span class="special">)</span><span class="special">></span> <span class="identifier">on_exit_handler</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</span> <span class="identifier">exec</span><span class="special">)</span> +<span class="special">{</span> + <span class="keyword">auto</span> <span class="identifier">handler</span> <span class="special">=</span> <span class="keyword">this</span><span class="special">-></span><span class="identifier">handler</span><span class="special">;</span> + <span class="keyword">return</span> <span class="special">[</span><span class="identifier">handler</span><span class="special">]</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">exit_code</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">&</span> <span class="identifier">ec</span><span class="special">)</span> + <span class="special">{</span> + <span class="identifier">handler</span><span class="special">(</span><span class="keyword">static_cast</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span><span class="special">(</span><span class="identifier">exit_code</span><span class="special">)</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">)</span><span class="special">;</span> + <span class="special">}</span><span class="special">;</span> + +<span class="special">}</span> +</pre> +<p>The callback will be obtained by calling this function on setup and it will be invoked when the process exits.</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>Cannot be used with boost::process::spawn </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="require_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="posix_executor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/get_io_service.html b/doc/html/boost/process/extend/get_io_service.html new file mode 100644 index 0000000000..9c7992004b --- /dev/null +++ b/doc/html/boost/process/extend/get_io_service.html @@ -0,0 +1,86 @@ +<!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>Function template get_io_service</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="throw_last_error.html" title="Function throw_last_error"> +<link rel="next" href="../group.html" title="Class group"> +</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="throw_last_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="../group.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.get_io_service"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template get_io_service</span></h2> +<p>boost::process::extend::get_io_service</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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Sequence<span class="special">></span> + <span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">get_io_service</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Sequence</span> <span class="special">&</span> seq<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435859200"></a><h2>Description</h2> +<p>This function gets the io_service from the initializer sequence.</p> +<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>Yields a compile-time error if no <code class="computeroutput">io_service</code> is provided. </p></td></tr> +</table></div> +<p> + +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">seq</code></span></p></td> +<td><p>The Sequence of the initializer. </p></td> +</tr></tbody> +</table></div></td> +</tr></tbody> +</table></div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="throw_last_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="../group.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/handler.html b/doc/html/boost/process/extend/handler.html new file mode 100644 index 0000000000..c02b230f78 --- /dev/null +++ b/doc/html/boost/process/extend/handler.html @@ -0,0 +1,181 @@ +<!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>Struct handler</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="../exe.html" title="Global exe"> +<link rel="next" href="require_io_service.html" title="Struct require_io_service"> +</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="../exe.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="require_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.handler"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct handler</span></h2> +<p>boost::process::extend::handler</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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span> +<span class="keyword">struct</span> <a class="link" href="handler.html" title="Struct handler">handler</a> <span class="special">{</span> + + <span class="comment">// <a class="link" href="handler.html#idp38454944-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> <span class="keyword">void</span> <a class="link" href="handler.html#idp38455504-bb"><span class="identifier">on_setup</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="handler.html#idp38459328-bb"><span class="identifier">on_error</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> <span class="keyword">void</span> <a class="link" href="handler.html#idp38463744-bb"><span class="identifier">on_success</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="handler.html#idp38467456-bb"><span class="identifier">on_fork_error</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> <span class="keyword">void</span> <a class="link" href="handler.html#idp38472320-bb"><span class="identifier">on_exec_setup</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="handler.html#idp38477552-bb"><span class="identifier">on_exec_error</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435100624"></a><h2>Description</h2> +<p>This class is the base for every initializer, to be used for extensions.</p> +<p>The usage is done through compile-time polymorphism, so that the required functions can be overloaded.</p> +<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>None of the function need to be <code class="computeroutput">const</code>. </p></td></tr> +</table></div> +<p> +</p> +<div class="refsect2"> +<a name="idp435103136"></a><h3> +<a name="idp38454944-bb"></a><code class="computeroutput">handler</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> <span class="keyword">void</span> <a name="idp38455504-bb"></a><span class="identifier">on_setup</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>This function is invoked before the process launch. <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>It is not required to be const. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> + <span class="keyword">void</span> <a name="idp38459328-bb"></a><span class="identifier">on_error</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>This function is invoked if an error occured while trying to launch the process. </p> +<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>It is not required to be const. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> <span class="keyword">void</span> <a name="idp38463744-bb"></a><span class="identifier">on_success</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>This function is invoked if the process was successfully launched. </p> +<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>It is not required to be const. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> + <span class="keyword">void</span> <a name="idp38467456-bb"></a><span class="identifier">on_fork_error</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>This function is invoked if an error occured during the call of <code class="computeroutput">fork</code>. </p> +<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>This function will only be called on posix. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> <span class="keyword">void</span> <a name="idp38472320-bb"></a><span class="identifier">on_exec_setup</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>This function is invoked if the call of <code class="computeroutput">fork</code> was successful, before calling <code class="computeroutput">execve</code>. </p> +<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>This function will only be called on posix. </p></td></tr> +</table></div> +<p> +</p> +<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>It will be invoked from the new process. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Executor<span class="special">></span> + <span class="keyword">void</span> <a name="idp38477552-bb"></a><span class="identifier">on_exec_error</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&</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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>This function is invoked if the call of <code class="computeroutput">execve</code> failed. </p> +<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>This function will only be called on posix. </p></td></tr> +</table></div> +<p> +</p> +<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>It will be invoked from the new process. </p></td></tr> +</table></div> +<p> +</p> +</li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="../exe.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="require_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/on_error.html b/doc/html/boost/process/extend/on_error.html new file mode 100644 index 0000000000..03e6b560ae --- /dev/null +++ b/doc/html/boost/process/extend/on_error.html @@ -0,0 +1,51 @@ +<!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_error</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="on_setup.html" title="Global on_setup"> +<link rel="next" href="on_success.html" title="Global on_success"> +</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="on_setup.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_success.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.on_error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global on_error</span></h2> +<p>boost::process::extend::on_error — This handler is invoked if an error occured. The required signature is <code class="computeroutput">void(auto & exec, const std::error_code&)</code>, where <code class="computeroutput">Exec</code> is a template parameter. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> on_error<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="on_setup.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_success.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/on_exec_error.html b/doc/html/boost/process/extend/on_exec_error.html new file mode 100644 index 0000000000..5e1c6e1fce --- /dev/null +++ b/doc/html/boost/process/extend/on_exec_error.html @@ -0,0 +1,63 @@ +<!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_exec_error</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="on_exec_setup.html" title="Global on_exec_setup"> +<link rel="next" href="throw_last_error.html" title="Function throw_last_error"> +</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="on_exec_setup.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="throw_last_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.on_exec_error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global on_exec_error</span></h2> +<p>boost::process::extend::on_exec_error — This handler is invoked if the exec call errored. The required signature is <code class="computeroutput">void(auto & exec)</code>, where <code class="computeroutput">Exec</code> is a template parameter. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> on_exec_error<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435826864"></a><h2>Description</h2> +<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>Only available on posix. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="on_exec_setup.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="throw_last_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/on_exec_setup.html b/doc/html/boost/process/extend/on_exec_setup.html new file mode 100644 index 0000000000..2318f1b5c7 --- /dev/null +++ b/doc/html/boost/process/extend/on_exec_setup.html @@ -0,0 +1,63 @@ +<!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_exec_setup</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="on_fork_error.html" title="Global on_fork_error"> +<link rel="next" href="on_exec_error.html" title="Global on_exec_error"> +</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="on_fork_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_exec_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.on_exec_setup"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global on_exec_setup</span></h2> +<p>boost::process::extend::on_exec_setup — This handler is invoked if the fork succeeded. The required signature is <code class="computeroutput">void(Exec &)</code>, where <code class="computeroutput">Exec</code> is a template parameter. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> on_exec_setup<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435818896"></a><h2>Description</h2> +<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>Only available on posix. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="on_fork_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_exec_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/on_fork_error.html b/doc/html/boost/process/extend/on_fork_error.html new file mode 100644 index 0000000000..e06cd25eaf --- /dev/null +++ b/doc/html/boost/process/extend/on_fork_error.html @@ -0,0 +1,63 @@ +<!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_fork_error</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="on_success.html" title="Global on_success"> +<link rel="next" href="on_exec_setup.html" title="Global on_exec_setup"> +</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="on_success.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_exec_setup.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.on_fork_error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global on_fork_error</span></h2> +<p>boost::process::extend::on_fork_error — This handler is invoked if the fork failed. The required signature is <code class="computeroutput">void(auto & exec)</code>, where <code class="computeroutput">Exec</code> is a template parameter. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> on_fork_error<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435810928"></a><h2>Description</h2> +<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>Only available on posix. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="on_success.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_exec_setup.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/on_setup.html b/doc/html/boost/process/extend/on_setup.html new file mode 100644 index 0000000000..4f275ed937 --- /dev/null +++ b/doc/html/boost/process/extend/on_setup.html @@ -0,0 +1,51 @@ +<!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_setup</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="windows_executor.html" title="Struct template windows_executor"> +<link rel="next" href="on_error.html" title="Global on_error"> +</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="windows_executor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.on_setup"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global on_setup</span></h2> +<p>boost::process::extend::on_setup — This handler is invoked before the process in launched, to setup parameters. The required signature is <code class="computeroutput">void(Exec &)</code>, where <code class="computeroutput">Exec</code> is a template parameter. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> on_setup<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="windows_executor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/on_success.html b/doc/html/boost/process/extend/on_success.html new file mode 100644 index 0000000000..3dc6f53fe7 --- /dev/null +++ b/doc/html/boost/process/extend/on_success.html @@ -0,0 +1,51 @@ +<!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_success</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="on_error.html" title="Global on_error"> +<link rel="next" href="on_fork_error.html" title="Global on_fork_error"> +</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="on_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_fork_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.on_success"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global on_success</span></h2> +<p>boost::process::extend::on_success — This handler is invoked if launching the process has succeeded. The required signature is <code class="computeroutput">void(auto & exec)</code>, where <code class="computeroutput">Exec</code> is a template parameter. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> on_success<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="on_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_fork_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/posix_executor.html b/doc/html/boost/process/extend/posix_executor.html new file mode 100644 index 0000000000..7765aa34c5 --- /dev/null +++ b/doc/html/boost/process/extend/posix_executor.html @@ -0,0 +1,203 @@ +<!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>Struct template posix_executor</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="async_handler.html" title="Struct async_handler"> +<link rel="next" href="windows_executor.html" title="Struct template windows_executor"> +</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="async_handler.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="windows_executor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.posix_executor"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template posix_executor</span></h2> +<p>boost::process::extend::posix_executor — The posix executor type. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Sequence<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="posix_executor.html" title="Struct template posix_executor">posix_executor</a> <span class="special">{</span> + + <span class="comment">// <a class="link" href="posix_executor.html#idp38536176-bb">public member functions</a></span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <a class="link" href="posix_executor.html#idp38536736-bb"><span class="identifier">error</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="posix_executor.html#idp38538208-bb"><span class="identifier">set_error</span></a><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">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="posix_executor.html#idp38541616-bb"><span class="identifier">set_error</span></a><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">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// public data members</span> + <span class="identifier">Sequence</span> <span class="special">&</span> <span class="identifier">seq</span><span class="special">;</span> <span class="comment">// A reference to the actual initializer-sequence. </span> + <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <span class="identifier">exe</span><span class="special">;</span> <span class="comment">// A pointer to the name of the executable. </span> + <span class="keyword">char</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <span class="identifier">cmd_line</span><span class="special">;</span> <span class="comment">// A pointer to the argument-vector. </span> + <span class="keyword">char</span> <span class="special">*</span><span class="special">*</span> <span class="identifier">env</span><span class="special">;</span> <span class="comment">// A pointer to the environment variables, as default it is set to <a href="http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap08.html" target="_top">environ</a></span> + <span class="identifier">pid_t</span> <span class="identifier">pid</span><span class="special">;</span> <span class="comment">// The pid of the process - it will be -1 before invoking <a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/fork.html" target="_top">fork</a>, and after forking either 0 for the new process or a positive value if in the current process. */. </span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">atomic</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <span class="special">></span> <span class="identifier">exit_status</span><span class="special">;</span> <span class="comment">// This shared-pointer holds the exit code. It's done this way, so it can be shared between an <code class="computeroutput">asio::io_service</code> and <a class="link" href="../child.html" title="Class child">child</a>. </span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435306432"></a><h2>Description</h2> +<p>This type represents the posix executor and can be used for overloading in a custom handler. </p> +<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>It is an alias for the implementation on posix, and a forward-declaration on windows.</p></td></tr> +</table></div> +<p> + + +As information for extension development, here is the structure of the process launching (in pseudo-code and uml) +</p> +<pre class="programlisting"> +<span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38455504-bb">on_setup</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">)</span><span class="special">;</span> + +<span class="keyword">if</span> <span class="special">(</span><a class="link" href="posix_executor.html#idp38536736-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> +<span class="special">{</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38459328-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="posix_executor.html#idp38536736-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">return</span> <a class="link" href="../child.html" title="Class child">child</a><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span> + +<span class="identifier">pid</span> <span class="special">=</span> <a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/fork.html" target="_top"><span class="identifier">fork</span><span class="special">(</span><span class="special">)</span></a> +<a class="link" href="handler.html#idp38455504-bb">on_setup</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">)</span><span class="special">;</span> + +<span class="keyword">if</span> <span class="special">(</span><span class="identifier">pid</span> <span class="special">==</span> <span class="special">-</span><span class="number">1</span><span class="special">)</span> <span class="comment">//fork error </span> +<span class="special">{</span> + <a class="link" href="posix_executor.html#idp38538208-bb">set_error</a><span class="special">(</span><a class="link" href="../../../process/reference.html#boost.process.extend.get_last_error">get_last_error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38467456-bb">on_fork_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="posix_executor.html#idp38536736-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38459328-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="posix_executor.html#idp38536736-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">return</span> <a class="link" href="../child.html" title="Class child">child</a><span class="special">(</span><span class="special">)</span> +<span class="special">}</span> +<span class="keyword">else</span> <span class="keyword">if</span> <span class="special">(</span><span class="identifier">pid</span> <span class="special">==</span> <span class="number">0</span><span class="special">)</span> <span class="comment">//child process</span> +<span class="special">{</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38472320-bb">on_exec_setup</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">)</span><span class="special">;</span> + <a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/exec.html" target="_top"><span class="identifier">execve</span></a><span class="special">(</span><span class="identifier">exe</span><span class="special">,</span> <span class="identifier">cmd_line</span><span class="special">,</span> <span class="identifier">env</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">auto</span> <span class="identifier">ec</span> <span class="special">=</span> <a class="link" href="../../../process/reference.html#boost.process.extend.get_last_error">get_last_error</a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38477552-bb">on_exec_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">)</span><span class="special">;</span> + + <span class="emphasis"><em><span class="identifier">unspecified</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></em></span><span class="comment">//here the error is send to the father process interally</span> + + <a href="http://en.cppreference.com/w/cpp/utility/program/exit" target="_top"><span class="identifier">std</span><span class="special">::</span><span class="identifier">exit</span></a><span class="special">(</span><a href="http://en.cppreference.com/w/c/program/EXIT_status" target="_top"><span class="identifier">EXIT_FAILURE</span></a><span class="special">)</span><span class="special">;</span> + <span class="keyword">return</span> <a class="link" href="../child.html" title="Class child">child</a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="comment">//for C++ compliance</span> +<span class="special">}</span> + +<a class="link" href="../child.html" title="Class child">child</a> <span class="identifier">c</span><span class="special">(</span><span class="identifier">pid</span><span class="special">,</span> <span class="identifier">exit_code</span><span class="special">)</span><span class="special">;</span> + +<span class="emphasis"><em><span class="identifier">unspecified</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></em></span><span class="comment">//here, we read the the error from the child process</span> + +<span class="keyword">if</span> <span class="special">(</span><a class="link" href="posix_executor.html#idp38536736-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38459328-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="posix_executor.html#idp38536736-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">else</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38459328-bb">on_success</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">)</span><span class="special">;</span> + +<span class="comment">//now we check again, because a on_success handler might've errored.</span> +<span class="keyword">if</span> <span class="special">(</span><a class="link" href="posix_executor.html#idp38536736-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> +<span class="special">{</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38459328-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="posix_executor.html#idp38536736-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">return</span> <a class="link" href="../child.html" title="Class child">child</a><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span> +<span class="keyword">else</span> + <span class="keyword">return</span> <span class="identifier">c</span><span class="special">;</span> +</pre> +<p> + +</p> +<div class="mediaobject"> +<img src="../../../boost_process/posix_success.svg"><div class="caption"><p>The sequence if when no error occurs.</p></div> +</div> +<p> + +</p> +<div class="mediaobject"> +<img src="../../../boost_process/posix_exec_err.svg"><div class="caption"><p>The sequence if the execution fails.</p></div> +</div> +<p> + +</p> +<div class="mediaobject"> +<img src="../../../boost_process/posix_fork_err.svg"><div class="caption"><p>The sequence if the fork fails.</p></div> +</div> +<p> + +</p> +<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>Error handling if execve fails is done through a pipe, unless ignore_error is used. </p></td></tr> +</table></div> +<p> +</p> +<div class="refsect2"> +<a name="idp435493088"></a><h3>Template Parameters</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">typename</span> Sequence</pre> +<p>The used initializer-sequence, it is fulfills the boost.fusion <a href="http://www.boost.org/doc/libs/master/libs/fusion/doc/html/fusion/sequence.html" target="_top">sequence</a> concept.</p> +</li></ol></div> +</div> +<div class="refsect2"> +<a name="idp435497072"></a><h3> +<a name="idp38536176-bb"></a><code class="computeroutput">posix_executor</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <a name="idp38536736-bb"></a><span class="identifier">error</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>This function returns a const reference to the error state of the executor. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38538208-bb"></a><span class="identifier">set_error</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">&</span> ec<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> msg<span class="special">)</span><span class="special">;</span></pre> +<p>This function can be used to report an error to the executor. This will be handled according to the configuration of the executor, i.e. it might throw an exception. </p> +<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>This is the required way to handle errors in initializers. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38541616-bb"></a><span class="identifier">set_error</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">&</span> ec<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> msg<span class="special">)</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="async_handler.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="windows_executor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/require_io_service.html b/doc/html/boost/process/extend/require_io_service.html new file mode 100644 index 0000000000..ed262c72c1 --- /dev/null +++ b/doc/html/boost/process/extend/require_io_service.html @@ -0,0 +1,57 @@ +<!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>Struct require_io_service</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="handler.html" title="Struct handler"> +<link rel="next" href="async_handler.html" title="Struct async_handler"> +</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="handler.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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_handler.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.require_io_service"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct require_io_service</span></h2> +<p>boost::process::extend::require_io_service</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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span> +<span class="keyword">struct</span> <a class="link" href="require_io_service.html" title="Struct require_io_service">require_io_service</a> <span class="special">{</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435185184"></a><h2>Description</h2> +<p>Inheriting the class will tell the launching process that an <code class="computeroutput">io_service</code> is needed. This should always be used when get_io_service is used. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="handler.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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_handler.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/throw_last_error.html b/doc/html/boost/process/extend/throw_last_error.html new file mode 100644 index 0000000000..d88b165337 --- /dev/null +++ b/doc/html/boost/process/extend/throw_last_error.html @@ -0,0 +1,85 @@ +<!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>Function throw_last_error</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="on_exec_error.html" title="Global on_exec_error"> +<link rel="next" href="get_io_service.html" title="Function template get_io_service"> +</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="on_exec_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="get_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.throw_last_error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function throw_last_error</span></h2> +<p>boost::process::extend::throw_last_error</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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span> +<span class="keyword">void</span> <span class="identifier">throw_last_error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> msg<span class="special">)</span><span class="special">;</span> +<span class="keyword">void</span> <span class="identifier">throw_last_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435840816"></a><h2>Description</h2> +<p>Helper function to get and throw the last system error. + +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">msg</code></span></p></td> +<td><p>A message to add to the error code. </p></td> +</tr></tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="../process_error.html" title="Struct process_error">boost::process::process_error</a> </td> +</tr> +</tbody> +</table></div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="on_exec_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="get_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/extend/windows_executor.html b/doc/html/boost/process/extend/windows_executor.html new file mode 100644 index 0000000000..8e0f7465f5 --- /dev/null +++ b/doc/html/boost/process/extend/windows_executor.html @@ -0,0 +1,189 @@ +<!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>Struct template windows_executor</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.extend_hpp" title="Header <boost/process/extend.hpp>"> +<link rel="prev" href="posix_executor.html" title="Struct template posix_executor"> +<link rel="next" href="on_setup.html" title="Global on_setup"> +</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="posix_executor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_setup.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.extend.windows_executor"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template windows_executor</span></h2> +<p>boost::process::extend::windows_executor — The windows executor type. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Sequence<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="windows_executor.html" title="Struct template windows_executor">windows_executor</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.extend.windows_executor.startup_info_t"></a><span class="identifier">startup_info_t</span><span class="special">;</span> <span class="comment">// The type of the <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms686331.aspx" target="_top">startup-info</a>, depending on the char-type. </span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.extend.windows_executor.startup_info_ex_t"></a><span class="identifier">startup_info_ex_t</span><span class="special">;</span> <span class="comment">// The type of the <a href="https://msdn.microsoft.com/de-de/library/windows/desktop/ms686329.aspx" target="_top">extended startup-info</a>, depending the char-type; only defined with winapi-version equal or higher than 6. </span> + + <span class="comment">// <a class="link" href="windows_executor.html#idp38590528-bb">public member functions</a></span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <a class="link" href="windows_executor.html#idp38591088-bb"><span class="identifier">error</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="windows_executor.html#idp38592560-bb"><span class="identifier">set_error</span></a><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">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="windows_executor.html#idp38595968-bb"><span class="identifier">set_error</span></a><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">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="windows_executor.html#idp38598736-bb"><span class="identifier">set_startup_info_ex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// public data members</span> + <span class="identifier">Sequence</span> <span class="special">&</span> <span class="identifier">seq</span><span class="special">;</span> <span class="comment">// A reference to the actual initializer-sequence. </span> + <span class="keyword">const</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="identifier">exe</span><span class="special">;</span> <span class="comment">// A pointer to the name of the executable. It's null by default. </span> + <span class="keyword">char</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="identifier">cmd_line</span><span class="special">;</span> <span class="comment">// A pointer to the argument-vector. Must be set by some initializer. </span> + <span class="keyword">char</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="identifier">env</span><span class="special">;</span> <span class="comment">// A pointer to the environment variables. It's null by default. </span> + <span class="keyword">const</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="identifier">work_dir</span><span class="special">;</span> <span class="comment">// A pointer to the working directory. It's null by default. </span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">proc_attrs</span><span class="special">;</span> <span class="comment">// A pointer to the process-attributes of type <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa379560.aspx" target="_top">SECURITY_ATTRIBUTES</a>. It's null by default. </span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">thread_attrs</span><span class="special">;</span> <span class="comment">// A pointer to the thread-attributes of type <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa379560.aspx" target="_top">SECURITY_ATTRIBUTES</a>. It' null by default. </span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">inherit_handles</span><span class="special">;</span> <span class="comment">// A logical bool value setting whether handles shall be inherited or not. </span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">proc_info</span><span class="special">;</span> <span class="comment">// The element holding the process-information after process creation. The type is <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms684873.aspx" target="_top">PROCESS_INFORMATION</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">atomic</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <span class="special">></span> <span class="identifier">exit_status</span><span class="special">;</span> <span class="comment">// This shared-pointer holds the exit code. It's done this way, so it can be shared between an <code class="computeroutput">asio::io_service</code> and <a class="link" href="../child.html" title="Class child">child</a>. </span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">creation_flags</span><span class="special">;</span> <span class="comment">// The creation flags of the process. </span> + <span class="identifier">startup_info_t</span> <span class="identifier">startup_info</span><span class="special">;</span> <span class="comment">// This element is an instance or a reference (if startup_info_ex exists) to the <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms686331.aspx" target="_top">startup-info</a> for the process. </span> + <span class="identifier">startup_info_ex_t</span> <span class="identifier">startup_info_ex</span><span class="special">;</span> <span class="comment">// This element is the instance of the <a href="https://msdn.microsoft.com/de-de/library/windows/desktop/ms686329.aspx" target="_top">extended startup-info</a>. It is only available with a winapi-version equal or highter than 6. </span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp435635312"></a><h2>Description</h2> +<p>This type represents the posix executor and can be used for overloading in a custom handler.</p> +<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>It is an alias for the implementation on posix, and a forward-declaration on windows. </p></td></tr> +</table></div> +<p> + + +As information for extension development, here is the structure of the process launching (in pseudo-code and uml)</p> +<pre class="programlisting"> +<span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38455504-bb">on_setup</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">)</span><span class="special">;</span> + +<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idp38591088-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> +<span class="special">{</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38459328-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="windows_executor.html#idp38591088-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">return</span> <a class="link" href="../child.html" title="Class child">child</a><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span> +<span class="keyword">int</span> <span class="identifier">err_code</span> <span class="special">=</span> <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms682425.aspx" target="_top"><span class="identifier">CreateProcess</span></a><span class="special">(</span> + <span class="identifier">exe</span><span class="special">,</span> + <span class="identifier">cmd_line</span><span class="special">,</span> + <span class="identifier">proc_attrs</span><span class="special">,</span> + <span class="identifier">thread_attrs</span><span class="special">,</span> + <span class="identifier">creation_flags</span><span class="special">,</span> + <span class="identifier">env</span><span class="special">,</span> + <span class="identifier">work_dir</span><span class="special">,</span> + <span class="identifier">startup_info</span><span class="special">,</span> + <span class="identifier">proc_info</span><span class="special">)</span><span class="special">;</span> + +<a class="link" href="../child.html" title="Class child">child</a> <span class="identifier">c</span><span class="special">(</span><span class="identifier">proc_info</span><span class="special">,</span> <span class="identifier">exit_code</span><span class="special">)</span><span class="special">;</span> + +<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idp38591088-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38459328-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="windows_executor.html#idp38591088-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">else</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38459328-bb">on_success</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">)</span><span class="special">;</span> + +<span class="comment">//now we check again, because a on_success handler might've errored.</span> +<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idp38591088-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> +<span class="special">{</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idp38459328-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="windows_executor.html#idp38591088-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">return</span> <a class="link" href="../child.html" title="Class child">child</a><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span> +<span class="keyword">else</span> + <span class="keyword">return</span> <span class="identifier">c</span><span class="special">;</span> + +</pre> +<p> +</p> +<div class="mediaobject"> +<img src="../../../boost_process/windows_exec.svg"><div class="caption"><p>The sequence for windows process creation.</p></div> +</div> +<p> + </p> +<div class="refsect2"> +<a name="idp435738176"></a><h3>Template Parameters</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">typename</span> Char</pre> +<p>The used char-type, either <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>.</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">typename</span> Sequence</pre> +<p>The used initializer-sequence, it is fulfills the boost.fusion <a href="http://www.boost.org/doc/libs/master/libs/fusion/doc/html/fusion/sequence.html" target="_top">sequence</a> concept. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp435745648"></a><h3> +<a name="idp38590528-bb"></a><code class="computeroutput">windows_executor</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <a name="idp38591088-bb"></a><span class="identifier">error</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>This function returns a const reference to the error state of the executor. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38592560-bb"></a><span class="identifier">set_error</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">&</span> ec<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> msg<span class="special">)</span><span class="special">;</span></pre> +<p>This function can be used to report an error to the executor. This will be handled according to the configuration of the executor, i.e. it might throw an exception. </p> +<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>This is the required way to handle errors in initializers. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38595968-bb"></a><span class="identifier">set_error</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">&</span> ec<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> msg<span class="special">)</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38598736-bb"></a><span class="identifier">set_startup_info_ex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>This function switches the information, so that the extended structure is used. <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>It's only defined with winapi-version equal or higher than 6. </p></td></tr> +</table></div> +<p> +</p> +</li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="posix_executor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_setup.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/group.html b/doc/html/boost/process/group.html new file mode 100644 index 0000000000..a6517f2415 --- /dev/null +++ b/doc/html/boost/process/group.html @@ -0,0 +1,242 @@ +<!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>Class group</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.group_hpp" title="Header <boost/process/group.hpp>"> +<link rel="prev" href="extend/get_io_service.html" title="Function template get_io_service"> +<link rel="next" href="close.html" title="Global close"> +</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="extend/get_io_service.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.group_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="close.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.group"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class group</span></h2> +<p>boost::process::group</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: <<a class="link" href="../../process/reference.html#header.boost.process.group_hpp" title="Header <boost/process/group.hpp>">boost/process/group.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.group.group_handle"></a><span class="identifier">group_handle</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">group_handle</span><span class="special">::</span><span class="identifier">handle_t</span> <a name="boost.process.group.native_handle_t"></a><span class="identifier">native_handle_t</span><span class="special">;</span> <span class="comment">// Native representation of the handle. </span> + + <span class="comment">// <a class="link" href="group.html#boost.process.groupconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">explicit</span> <a class="link" href="group.html#idp38681312-bb"><span class="identifier">group</span></a><span class="special">(</span><span class="identifier">group_handle</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="group.html#idp38682560-bb"><span class="identifier">group</span></a><span class="special">(</span><span class="identifier">native_handle_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="group.html#idp38684128-bb"><span class="identifier">group</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> + <a class="link" href="group.html#idp38685824-bb"><span class="identifier">group</span></a><span class="special">(</span><a class="link" href="group.html" title="Class group">group</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="group.html#idp38687376-bb"><span class="identifier">group</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> + <a class="link" href="group.html" title="Class group">group</a> <span class="special">&</span> <a class="link" href="group.html#idp38688224-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> + <a class="link" href="group.html" title="Class group">group</a> <span class="special">&</span> <a class="link" href="group.html#idp38690496-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="group.html" title="Class group">group</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="group.html#idp38692624-bb"><span class="special">~</span><span class="identifier">group</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="group.html#idp38636944-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="group.html#idp38637504-bb"><span class="identifier">detach</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="group.html#idp38638640-bb"><span class="identifier">join</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="group.html#idp38639984-bb"><span class="identifier">joinable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">native_handle_t</span> <a class="link" href="group.html#idp38641264-bb"><span class="identifier">native_handle</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="group.html#idp38642688-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="group.html#idp38643840-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="group.html#idp38646192-bb"><span class="identifier">wait_for</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special"><</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="group.html#idp38650080-bb"><span class="identifier">wait_for</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special"><</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</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">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="group.html#idp38654560-bb"><span class="identifier">wait_until</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special"><</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="group.html#idp38658448-bb"><span class="identifier">wait_until</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special"><</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</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">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="group.html#idp38662928-bb"><span class="identifier">valid</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="group.html#idp38664352-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="group.html#idp38666048-bb"><span class="identifier">terminate</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="group.html#idp38667232-bb"><span class="identifier">terminate</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="group.html#idp38669584-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="group.html#idp38671872-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="group.html#idp38675360-bb"><span class="identifier">has</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="group.html#idp38677664-bb"><span class="identifier">has</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp436080416"></a><h2>Description</h2> +<p>Represents a process group.</p> +<p>Groups are movable but non-copyable. The destructor automatically closes handles to the group process.</p> +<p>The group will have the same interface as std::thread.</p> +<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>If the destructor is called without a previous detach or wait, the group will be terminated.</p></td></tr> +</table></div> +<p> +</p> +<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>If a default-constructed group is used before being used in a process launch, the behaviour is undefined.</p> +<p>Waiting for groups is currently broken on windows and will most likely result in a dead-lock. </p> +</td></tr> +</table></div> +<p> +</p> +<div class="refsect2"> +<a name="idp436083584"></a><h3> +<a name="boost.process.groupconstruct-copy-destruct"></a><code class="computeroutput">group</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp38681312-bb"></a><span class="identifier">group</span><span class="special">(</span><span class="identifier">group_handle</span> <span class="special">&&</span> ch<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp38682560-bb"></a><span class="identifier">group</span><span class="special">(</span><span class="identifier">native_handle_t</span> <span class="special">&</span> handle<span class="special">)</span><span class="special">;</span></pre>Construct the group from a native_handle. </li> +<li class="listitem"><pre class="literallayout"><a name="idp38684128-bb"></a><span class="identifier">group</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38685824-bb"></a><span class="identifier">group</span><span class="special">(</span><a class="link" href="group.html" title="Class group">group</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre>Move constructor. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38687376-bb"></a><span class="identifier">group</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Default constructor. </li> +<li class="listitem"><pre class="literallayout"><a class="link" href="group.html" title="Class group">group</a> <span class="special">&</span> <a name="idp38688224-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="group.html" title="Class group">group</a> <span class="special">&</span> <a name="idp38690496-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="group.html" title="Class group">group</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre>Move assign. </li> +<li class="listitem"> +<pre class="literallayout"><a name="idp38692624-bb"></a><span class="special">~</span><span class="identifier">group</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Destructor</p> +<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>If the destructor is called without a previous detach or wait, the group will be terminated. </p></td></tr> +</table></div> +<p> +</p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp436136272"></a><h3> +<a name="idp38636944-bb"></a><code class="computeroutput">group</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38637504-bb"></a><span class="identifier">detach</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Detach the group. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38638640-bb"></a><span class="identifier">join</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Join the child. This just calls wait, but that way the naming is similar to std::thread </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38639984-bb"></a><span class="identifier">joinable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Check if the child is joinable. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">native_handle_t</span> <a name="idp38641264-bb"></a><span class="identifier">native_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Obtain the native handle of the group. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38642688-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Wait for the process group to exit. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38643840-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">></span> + <span class="keyword">bool</span> <a name="idp38646192-bb"></a><span class="identifier">wait_for</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special"><</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">></span> <span class="special">&</span> rel_time<span class="special">)</span><span class="special">;</span></pre> +<p>Wait for the process group to exit for period of time. +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>True if all child processes exited while waiting. </p></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">></span> + <span class="keyword">bool</span> <a name="idp38650080-bb"></a><span class="identifier">wait_for</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special"><</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">></span> <span class="special">&</span> rel_time<span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">></span> + <span class="keyword">bool</span> <a name="idp38654560-bb"></a><span class="identifier">wait_until</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special"><</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">></span> <span class="special">&</span> timeout_time<span class="special">)</span><span class="special">;</span></pre> +<p>Wait for the process group to exit until a point in time. +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>True if all child processes exited while waiting. </p></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">></span> + <span class="keyword">bool</span> <a name="idp38658448-bb"></a><span class="identifier">wait_until</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special"><</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">></span> <span class="special">&</span> timeout_time<span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38662928-bb"></a><span class="identifier">valid</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Check if the group has a valid handle. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp38664352-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Convenience to call valid. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38666048-bb"></a><span class="identifier">terminate</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Terminate the process group, i.e. all processes in the group. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38667232-bb"></a><span class="identifier">terminate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38669584-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span> c<span class="special">)</span><span class="special">;</span></pre>Assign a child process to the group. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp38671872-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span> c<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38675360-bb"></a><span class="identifier">has</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span> c<span class="special">)</span><span class="special">;</span></pre>Check if the child process is in the group. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38677664-bb"></a><span class="identifier">has</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&</span> c<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +</ol></div> +</div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="extend/get_io_service.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.group_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="close.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/ignore_error.html b/doc/html/boost/process/ignore_error.html new file mode 100644 index 0000000000..6e83d3bdee --- /dev/null +++ b/doc/html/boost/process/ignore_error.html @@ -0,0 +1,55 @@ +<!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 ignore_error</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.error_hpp" title="Header <boost/process/error.hpp>"> +<link rel="prev" href="basic_native_environment/entry_type.html" title="Struct template entry_type"> +<link rel="next" href="throw_on_error.html" title="Global throw_on_error"> +</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="basic_native_environment/entry_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="throw_on_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.ignore_error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global ignore_error</span></h2> +<p>boost::process::ignore_error</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: <<a class="link" href="../../process/reference.html#header.boost.process.error_hpp" title="Header <boost/process/error.hpp>">boost/process/error.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> ignore_error<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp434863280"></a><h2>Description</h2> +<p>The ignore_error property will disable any error handling. This can be useful on linux, where error handling will require a pipe. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="basic_native_environment/entry_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="throw_on_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/null.html b/doc/html/boost/process/null.html new file mode 100644 index 0000000000..dfa093d8f8 --- /dev/null +++ b/doc/html/boost/process/null.html @@ -0,0 +1,51 @@ +<!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 null</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.io_hpp" title="Header <boost/process/io.hpp>"> +<link rel="prev" href="close.html" title="Global close"> +<link rel="next" href="std_in.html" title="Global std_in"> +</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="close.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="std_in.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.null"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global null</span></h2> +<p>boost::process::null — This constant is a utility to redirect streams to the null-device. </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: <<a class="link" href="../../process/reference.html#header.boost.process.io_hpp" title="Header <boost/process/io.hpp>">boost/process/io.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> null<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="close.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="std_in.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/on_exit.html b/doc/html/boost/process/on_exit.html new file mode 100644 index 0000000000..aa6eaef1c2 --- /dev/null +++ b/doc/html/boost/process/on_exit.html @@ -0,0 +1,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 <boost/process/async.hpp>"> +<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: <<a class="link" href="../../process/reference.html#header.boost.process.async_hpp" title="Header <boost/process/async.hpp>">boost/process/async.hpp</a>> + +</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="idp431909520"></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&)</code> or an <code class="computeroutput">std::future<int></code>.</p> +<p><b>Example. </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">&</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"><</span><span class="keyword">int</span><span class="special">></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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> diff --git a/doc/html/boost/process/posix/fd.html b/doc/html/boost/process/posix/fd.html new file mode 100644 index 0000000000..4a8a1acdb3 --- /dev/null +++ b/doc/html/boost/process/posix/fd.html @@ -0,0 +1,57 @@ +<!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 fd</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.posix_hpp" title="Header <boost/process/posix.hpp>"> +<link rel="prev" href="../basic_pstream.html" title="Class template basic_pstream"> +<link rel="next" href="sig.html" title="Global sig"> +</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="../basic_pstream.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.posix_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="sig.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.posix.fd"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global fd</span></h2> +<p>boost::process::posix::fd</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: <<a class="link" href="../../../process/reference.html#header.boost.process.posix_hpp" title="Header <boost/process/posix.hpp>">boost/process/posix.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> fd<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp438105536"></a><h2>Description</h2> +<p>This property lets you modify file-descriptors other than the standard ones (0,1,2).</p> +<p>It provides the functions <code class="computeroutput">bind</code>, which implements <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/dup.html" target="_top">dup2</a> and <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/close.html" target="_top">close</a>.</p> +<p>Close can also be called with a range of file-descriptors to be closed. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="../basic_pstream.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.posix_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="sig.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/posix/sig.html b/doc/html/boost/process/posix/sig.html new file mode 100644 index 0000000000..a54c85ce76 --- /dev/null +++ b/doc/html/boost/process/posix/sig.html @@ -0,0 +1,68 @@ +<!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 sig</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.posix_hpp" title="Header <boost/process/posix.hpp>"> +<link rel="prev" href="fd.html" title="Global fd"> +<link rel="next" href="use_vfork.html" title="Global use_vfork"> +</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="fd.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.posix_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="use_vfork.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.posix.sig"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global sig</span></h2> +<p>boost::process::posix::sig</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: <<a class="link" href="../../../process/reference.html#header.boost.process.posix_hpp" title="Header <boost/process/posix.hpp>">boost/process/posix.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> sig<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp438114304"></a><h2>Description</h2> +<p>This property lets you modify the handling of <code class="computeroutput">SIGCHLD</code> for this call. It will be reset afterwards.</p> +<p>It can be set to default, by the expression <code class="computeroutput">sig.dfl()</code>, set to ignore with <code class="computeroutput">sig.ign()</code> or assigned a custom handler. A custom handler must have the type <code class="computeroutput">sighandler_t</code>and can be assigned with the following syntax:</p> +<pre class="programlisting"><span class="identifier">sig</span> <span class="special">=</span> <span class="identifier">handler</span><span class="special">;</span> +<span class="identifier">sig</span><span class="special">(</span><span class="identifier">handler</span><span class="special">)</span><span class="special">;</span> +</pre> +<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>spawn will automatically use <code class="computeroutput">sig.ign()</code>, which will override if you pass a custom handler. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="fd.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.posix_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="use_vfork.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/posix/use_vfork.html b/doc/html/boost/process/posix/use_vfork.html new file mode 100644 index 0000000000..528a8f0e86 --- /dev/null +++ b/doc/html/boost/process/posix/use_vfork.html @@ -0,0 +1,64 @@ +<!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 use_vfork</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.posix_hpp" title="Header <boost/process/posix.hpp>"> +<link rel="prev" href="sig.html" title="Global sig"> +<link rel="next" href="../search_path.html" title="Function search_path"> +</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="sig.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.posix_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="../search_path.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.posix.use_vfork"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global use_vfork</span></h2> +<p>boost::process::posix::use_vfork</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: <<a class="link" href="../../../process/reference.html#header.boost.process.posix_hpp" title="Header <boost/process/posix.hpp>">boost/process/posix.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> use_vfork<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp438130752"></a><h2>Description</h2> +<p>This property will replace the usage of <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/fork.html" target="_top">fork</a> by <a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/vfork.html" target="_top">vfork</a>. </p> +<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><code class="computeroutput">vfork</code> is no longer an official part of the posix standard. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="sig.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.posix_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="../search_path.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/process_error.html b/doc/html/boost/process/process_error.html new file mode 100644 index 0000000000..a103a0d292 --- /dev/null +++ b/doc/html/boost/process/process_error.html @@ -0,0 +1,57 @@ +<!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>Struct process_error</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.exception_hpp" title="Header <boost/process/exception.hpp>"> +<link rel="prev" href="error_code.html" title="Global error_code"> +<link rel="next" href="exe.html" title="Global exe"> +</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="error_code.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.exception_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="exe.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.process_error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct process_error</span></h2> +<p>boost::process::process_error — The exception usually thrown by boost.process. </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: <<a class="link" href="../../process/reference.html#header.boost.process.exception_hpp" title="Header <boost/process/exception.hpp>">boost/process/exception.hpp</a>> + +</span> +<span class="keyword">struct</span> <a class="link" href="process_error.html" title="Struct process_error">process_error</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">system_error</span> <span class="special">{</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp434924128"></a><h2>Description</h2> +<p>It merely inherits <a href="http://en.cppreference.com/w/cpp/error/system_error" target="_top">std::system_error</a> but can then be distinguished in the catch-block from other system errors. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="error_code.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.exception_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="exe.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/search_path.html b/doc/html/boost/process/search_path.html new file mode 100644 index 0000000000..b43aee2533 --- /dev/null +++ b/doc/html/boost/process/search_path.html @@ -0,0 +1,93 @@ +<!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>Function search_path</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.search_path_hpp" title="Header <boost/process/search_path.hpp>"> +<link rel="prev" href="posix/use_vfork.html" title="Global use_vfork"> +<link rel="next" href="shell.html" title="Global shell"> +</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="posix/use_vfork.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.search_path_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="shell.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.search_path"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function search_path</span></h2> +<p>boost::process::search_path</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: <<a class="link" href="../../process/reference.html#header.boost.process.search_path_hpp" title="Header <boost/process/search_path.hpp>">boost/process/search_path.hpp</a>> + +</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">filesystem</span><span class="special">::</span><span class="identifier">path</span> +<span class="identifier">search_path</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">filesystem</span><span class="special">::</span><span class="identifier">path</span> <span class="special">&</span> filename<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">filesystem</span><span class="special">::</span><span class="identifier">path</span> <span class="special">></span> path <span class="special">=</span> <span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">this_process</span><span class="special">::</span><span class="identifier">path</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp438189536"></a><h2>Description</h2> +<p>Searches for an executable in path.</p> +<p>filename must be a basename including the file extension. It must not include any directory separators (like a slash). On Windows the file extension may be omitted. The function will then try the various file extensions for executables on Windows to find filename.</p> +<p> + +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">filename</code></span></p></td> +<td><p>The base of the filename to find</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">path</code></span></p></td> +<td><p>the set of paths so search, defaults to "PATH" environment variable.</p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>the absolute path to the executable filename or an empty string if filename isn't found </p></td> +</tr> +</tbody> +</table></div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="posix/use_vfork.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.search_path_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="shell.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/shell.html b/doc/html/boost/process/shell.html new file mode 100644 index 0000000000..acad35b497 --- /dev/null +++ b/doc/html/boost/process/shell.html @@ -0,0 +1,75 @@ +<!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 shell</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.shell_hpp" title="Header <boost/process/shell.hpp>"> +<link rel="prev" href="search_path.html" title="Function search_path"> +<link rel="next" href="spawn.html" title="Function template spawn"> +</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="search_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.shell_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="spawn.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.shell"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global shell</span></h2> +<p>boost::process::shell</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: <<a class="link" href="../../process/reference.html#header.boost.process.shell_hpp" title="Header <boost/process/shell.hpp>">boost/process/shell.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> shell<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp438212224"></a><h2>Description</h2> +<p>The shell property enables to launch a program through the shell of the system.</p> +<pre class="programlisting"><span class="identifier">system</span><span class="special">(</span><span class="string">"gcc"</span><span class="special">,</span> <span class="identifier">shell</span><span class="special">)</span><span class="special">;</span> +</pre> +<p>The shell argument goes without any expression. The operator() is overloaded, to obtain the path of the system shell.</p> +<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">shell_cmd</span> <span class="special">=</span> <span class="identifier">shell</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="comment">//avoid exceptions</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">;</span> +<span class="identifier">shell_cmd</span> <span class="special">=</span> <span class="identifier">shell</span><span class="special">(</span><span class="identifier">ec</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>Launching through the shell will NOT provide proper error handling, i.e. you will get an error via the return code.</p> +<p>Executing shell commands that incorporate unsanitized input from an untrusted source makes a program vulnerable to shell injection, a serious security flaw which can result in arbitrary command execution. For this reason, the use of <code class="computeroutput">shell</code> is strongly discouraged in cases where the command string is constructed from external input: </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="search_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.shell_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="spawn.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/spawn.html b/doc/html/boost/process/spawn.html new file mode 100644 index 0000000000..ea16786c41 --- /dev/null +++ b/doc/html/boost/process/spawn.html @@ -0,0 +1,75 @@ +<!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>Function template 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="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../process/reference.html#header.boost.process.spawn_hpp" title="Header <boost/process/spawn.hpp>"> +<link rel="prev" href="shell.html" title="Global shell"> +<link rel="next" href="start_dir.html" title="Global start_dir"> +</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="shell.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.spawn_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="start_dir.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.spawn"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template spawn</span></h2> +<p>boost::process::spawn</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: <<a class="link" href="../../process/reference.html#header.boost.process.spawn_hpp" title="Header <boost/process/spawn.hpp>">boost/process/spawn.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> <span class="keyword">void</span> <span class="identifier">spawn</span><span class="special">(</span><span class="identifier">Args</span> <span class="special">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp438260688"></a><h2>Description</h2> +<p>Launch a process and detach it. Returns no handle.</p> +<p>This function starts a process and immediately detaches it. It thereby prevents the system from creating a zombie process, but will also cause the system to be unable to wait for the child to exit.</p> +<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>This will set <code class="computeroutput">SIGCHLD</code> to <code class="computeroutput">SIGIGN</code> on posix.</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>This function does not allow asynchronous operations, since it cannot wait for the end of the process. It will fail to compile if a reference to <code class="computeroutput">boost::asio::io_service</code> is passed. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="shell.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.spawn_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="start_dir.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/start_dir.html b/doc/html/boost/process/start_dir.html new file mode 100644 index 0000000000..52154cfe24 --- /dev/null +++ b/doc/html/boost/process/start_dir.html @@ -0,0 +1,60 @@ +<!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 start_dir</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.start_dir_hpp" title="Header <boost/process/start_dir.hpp>"> +<link rel="prev" href="spawn.html" title="Function template spawn"> +<link rel="next" href="system.html" title="Function template system"> +</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="spawn.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.start_dir_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="system.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.start_dir"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global start_dir</span></h2> +<p>boost::process::start_dir</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: <<a class="link" href="../../process/reference.html#header.boost.process.start_dir_hpp" title="Header <boost/process/start_dir.hpp>">boost/process/start_dir.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> start_dir<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp438281296"></a><h2>Description</h2> +<p>To set the start dir, the <code class="computeroutput">start_dir</code> property is provided.</p> +<p>The valid operations are the following:</p> +<pre class="programlisting"><span class="identifier">start_dir</span><span class="special">=</span><span class="identifier">path</span> +<span class="identifier">start_dir</span><span class="special">(</span><span class="identifier">path</span><span class="special">)</span> +</pre> +<p>It can be used with <code class="computeroutput">std::string</code>, <code class="computeroutput">std::wstring</code> and <code class="computeroutput">boost::filesystem::path</code>. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="spawn.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.start_dir_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="system.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/std_err.html b/doc/html/boost/process/std_err.html new file mode 100644 index 0000000000..5d32ad22fc --- /dev/null +++ b/doc/html/boost/process/std_err.html @@ -0,0 +1,55 @@ +<!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 std_err</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.io_hpp" title="Header <boost/process/io.hpp>"> +<link rel="prev" href="std_out.html" title="Global std_out"> +<link rel="next" href="basic_pipe.html" title="Class template basic_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="std_out.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="basic_pipe.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.std_err"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global std_err</span></h2> +<p>boost::process::std_err</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: <<a class="link" href="../../process/reference.html#header.boost.process.io_hpp" title="Header <boost/process/io.hpp>">boost/process/io.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> std_err<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp436704992"></a><h2>Description</h2> +<p>This property allows setting the <code class="computeroutput">stderr</code> stream. The semantic and syntax is the same as for <a class="link" href="std_out.html" title="Global std_out">std_out</a> . </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="std_out.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="basic_pipe.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/std_in.html b/doc/html/boost/process/std_in.html new file mode 100644 index 0000000000..6056fd5785 --- /dev/null +++ b/doc/html/boost/process/std_in.html @@ -0,0 +1,203 @@ +<!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 std_in</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.io_hpp" title="Header <boost/process/io.hpp>"> +<link rel="prev" href="null.html" title="Global null"> +<link rel="next" href="std_out.html" title="Global std_out"> +</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="null.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="std_out.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.std_in"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global std_in</span></h2> +<p>boost::process::std_in</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: <<a class="link" href="../../process/reference.html#header.boost.process.io_hpp" title="Header <boost/process/io.hpp>">boost/process/io.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> std_in<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp436434896"></a><h2>Description</h2> +<p>This property allows to set the input stream for the child process.</p> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="namespaceboost_1_1process_1stdin_details"></a>Details</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt><span class="sect2"><a href="std_in.html#namespaceboost_1_1process_1stdin_file">File Input</a></span></dt> +<dt><span class="sect2"><a href="std_in.html#namespaceboost_1_1process_1stdin_pipe">Pipe Input</a></span></dt> +<dt><span class="sect2"><a href="std_in.html#namespaceboost_1_1process_1stdin_async_pipe">Asynchronous Pipe Input</a></span></dt> +<dt><span class="sect2"><a href="std_in.html#namespaceboost_1_1process_1stdin_close">Close</a></span></dt> +<dt><span class="sect2"><a href="std_in.html#namespaceboost_1_1process_1stdin_null">Null</a></span></dt> +</dl></div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdin_file"></a>File Input</h3></div></div></div> +<p>The file I/O simple redirects the stream to a file, for which the possible types are</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">boost::filesystem::path</code></p></li> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type*</code></p></li> +<li class="listitem"><p><code class="computeroutput">FILE*</code></p></li> +</ul></div> +<p> +</p> +<p>with <code class="computeroutput">char_type</code> being either <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>.</p> +<p>FILE* is explicitly added, so the process can easily redirect the output stream of the child to another output stream of the process. That is:</p> +<pre class="programlisting"><span class="identifier">system</span><span class="special">(</span><span class="string">"ls"</span><span class="special">,</span> <span class="identifier">std_in</span> <span class="special"><</span> <span class="identifier">stdin</span><span class="special">)</span><span class="special">;</span> +</pre> +<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>If the launching and the child process use the input, this leads to undefined behaviour.</p></td></tr> +</table></div> +<p> +A syntax like <code class="computeroutput">system("ls", std_out > std::cerr)</code> is not possible, due to the C++ implementation not providing access to the handle.</p> +<p>The valid expressions for this property are</p> +<pre class="programlisting"><span class="identifier">std_in</span> <span class="special"><</span> <span class="identifier">file</span><span class="special">;</span> +<span class="identifier">std_in</span> <span class="special">=</span> <span class="identifier">file</span><span class="special">;</span> +</pre> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdin_pipe"></a>Pipe Input</h3></div></div></div> +<p>As explained in the corresponding section, the boost.process library provides a <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> class which can be used to communicate with child processes.</p> +<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>Technically the <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> works synchronous here, since no asio implementation is used by the library here. The async-operation will then however not end if the process is finished, since the pipe remains open. You can use the async_close function with on_exit to fix that.</p></td></tr> +</table></div> +<p> +Valid expressions with pipes are these:</p> +<pre class="programlisting"><span class="identifier">std_in</span> <span class="special"><</span> <span class="identifier">pipe</span><span class="special">;</span> +<span class="identifier">std_in</span> <span class="special">=</span> <span class="identifier">pipe</span><span class="special">;</span> +</pre> +<p>Where the valid types for <code class="computeroutput">pipe</code> are the following:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a></code></p></li> +<li class="listitem"><p><code class="computeroutput"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a></code></p></li> +<li class="listitem"><p><code class="computeroutput"><a class="link" href="basic_opstream.html" title="Class template basic_opstream">basic_opstream</a></code></p></li> +<li class="listitem"><p><code class="computeroutput"><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a></code></p></li> +</ul></div> +<p> +</p> +<p>Note that the pipe may also be used between several processes, like this:</p> +<pre class="programlisting"><span class="identifier">pipe</span> <span class="identifier">p</span><span class="special">;</span> +<span class="identifier">child</span> <span class="identifier">c1</span><span class="special">(</span><span class="string">"nm"</span><span class="special">,</span> <span class="string">"a.out"</span><span class="special">,</span> <span class="identifier">std_out</span><span class="special">></span><span class="identifier">p</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">child</span> <span class="identifier">c2</span><span class="special">(</span><span class="string">"c++filt"</span><span class="special">,</span> <span class="identifier">std_in</span><span class="special"><</span><span class="identifier">p</span><span class="special">)</span><span class="special">;</span> +</pre> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdin_async_pipe"></a>Asynchronous Pipe Input</h3></div></div></div> +<p>Asynchronous Pipe I/O classifies communication which has automatically handling of the asynchronous operations by the process library. This means, that a pipe will be constructed, the async_read/-write will be automatically started, and that the end of the child process will also close the pipe.</p> +<p>Valid types for pipe I/O are the following:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">boost::asio::const_buffer</code> <a href="#ftn.idp436494960" class="footnote" name="idp436494960"><sup class="footnote">[24]</sup></a> </p></li> +<li class="listitem"><p><code class="computeroutput">boost::asio::mutable_buffer</code> <a href="#ftn.idp436497024" class="footnote" name="idp436497024"><sup class="footnote">[25]</sup></a> </p></li> +<li class="listitem"><p><code class="computeroutput">boost::asio::streambuf</code></p></li> +</ul></div> +<p> +</p> +<p>Valid expressions with pipes are these:</p> +<pre class="programlisting"><span class="identifier">std_in</span> <span class="special"><</span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="identifier">std_in</span> <span class="special">=</span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="identifier">std_out</span> <span class="special">></span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="identifier">std_out</span> <span class="special">=</span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="identifier">std_err</span> <span class="special">></span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="identifier">std_err</span> <span class="special">=</span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="special">(</span><span class="identifier">std_out</span> <span class="special">&</span> <span class="identifier">std_err</span><span class="special">)</span> <span class="special">></span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="special">(</span><span class="identifier">std_out</span> <span class="special">&</span> <span class="identifier">std_err</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">buffer</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>It is also possible to get a future for std_in, by chaining another <code class="computeroutput">std::future<void></code> onto it, so you can wait for the input to be completed. It looks like this: </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">future</span><span class="special"><</span><span class="keyword">void</span><span class="special">></span> <span class="identifier">fut</span><span class="special">;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="identifier">ios</span><span class="special">;</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">data</span><span class="special">;</span> +<span class="identifier">child</span> <span class="identifier">c</span><span class="special">(</span><span class="string">"prog"</span><span class="special">,</span> <span class="identifier">std_in</span> <span class="special"><</span> <span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">)</span> <span class="special">></span> <span class="identifier">fut</span><span class="special">,</span> <span class="identifier">ios</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">fut</span><span class="special">.</span><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +</pre> +<p><code class="computeroutput">boost::asio::buffer</code> is also available in the <code class="computeroutput">boost::process</code> namespace.</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>This feature requires <code class="computeroutput">boost/process/async.hpp</code> to be included and a reference to <code class="computeroutput">boost::asio::io_service</code> to be passed to the launching function.</p></td></tr> +</table></div> +<p> +</p> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdin_close"></a>Close</h3></div></div></div> +<p>The input stream can be closed, so it cannot be read from. This will lead to an error when attempted.</p> +<p>This can be achieved by the following syntax.</p> +<pre class="programlisting"><span class="identifier">std_in</span> <span class="special"><</span> <span class="identifier">close</span><span class="special">;</span> +<span class="identifier">std_in</span> <span class="special">=</span> <span class="identifier">close</span><span class="special">;</span> +<span class="identifier">std_in</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +</pre> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdin_null"></a>Null</h3></div></div></div> +<p>The input stream can be redirected to read from the null-device, which means that only <code class="computeroutput">EOF</code> is read.</p> +<p>The syntax to achieve that has the following variants:</p> +<pre class="programlisting"><span class="identifier">std_in</span> <span class="special"><</span> <span class="identifier">null</span><span class="special">;</span> +<span class="identifier">std_in</span> <span class="special">=</span> <span class="identifier">null</span><span class="special">;</span> +<span class="identifier">std_in</span><span class="special">.</span><span class="identifier">null</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +</pre> +<p> </p> +</div> +</div> +</div> +<div class="footnotes"> +<br><hr style="width:100; text-align:left;margin-left: 0"> +<div id="ftn.idp436494960" class="footnote"><p><a href="#idp436494960" class="para"><sup class="para">[24] </sup></a> Constructed with <code class="computeroutput">boost::asio::buffer</code></p></div> +<div id="ftn.idp436497024" class="footnote"><p><a href="#idp436497024" class="para"><sup class="para">[25] </sup></a> Constructed with <code class="computeroutput">boost::asio::buffer</code></p></div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="null.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="std_out.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/std_out.html b/doc/html/boost/process/std_out.html new file mode 100644 index 0000000000..bd0517e7e0 --- /dev/null +++ b/doc/html/boost/process/std_out.html @@ -0,0 +1,204 @@ +<!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 std_out</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.io_hpp" title="Header <boost/process/io.hpp>"> +<link rel="prev" href="std_in.html" title="Global std_in"> +<link rel="next" href="std_err.html" title="Global std_err"> +</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="std_in.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="std_err.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.std_out"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global std_out</span></h2> +<p>boost::process::std_out</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: <<a class="link" href="../../process/reference.html#header.boost.process.io_hpp" title="Header <boost/process/io.hpp>">boost/process/io.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> std_out<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp436584160"></a><h2>Description</h2> +<p>This property allows to set the output stream for the child process.</p> +<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 Semantic is the same as for <a class="link" href="std_err.html" title="Global std_err">std_err</a> </p> +<p><code class="computeroutput">std_err</code> and <code class="computeroutput">std_out</code> can be combined into one stream, with the <code class="computeroutput">operator &</code>, i.e. <code class="computeroutput">std_out & std_err</code>.</p> +</td></tr> +</table></div> +<p> +</p> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="namespaceboost_1_1process_1stdout_details"></a>Details</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt><span class="sect2"><a href="std_out.html#namespaceboost_1_1process_1stdout_file">File Input</a></span></dt> +<dt><span class="sect2"><a href="std_out.html#namespaceboost_1_1process_1stdout_pipe">Pipe Output</a></span></dt> +<dt><span class="sect2"><a href="std_out.html#namespaceboost_1_1process_1stdout_async_pipe">Asynchronous Pipe Output</a></span></dt> +<dt><span class="sect2"><a href="std_out.html#namespaceboost_1_1process_1stdout_close">Close</a></span></dt> +<dt><span class="sect2"><a href="std_out.html#namespaceboost_1_1process_1stdout_null">Null</a></span></dt> +</dl></div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdout_file"></a>File Input</h3></div></div></div> +<p>The file I/O simple redirects the stream to a file, for which the possible types are</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">boost::filesystem::path</code></p></li> +<li class="listitem"><p><code class="computeroutput">std::basic_string<char_type></code></p></li> +<li class="listitem"><p><code class="computeroutput">const char_type*</code></p></li> +<li class="listitem"><p><code class="computeroutput">FILE*</code></p></li> +</ul></div> +<p> +</p> +<p>with <code class="computeroutput">char_type</code> being either <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>.</p> +<p>FILE* is explicitly added, so the process can easily redirect the output stream of the child to another output stream of the process. That is:</p> +<pre class="programlisting"><span class="identifier">system</span><span class="special">(</span><span class="string">"ls"</span><span class="special">,</span> <span class="identifier">std_out</span> <span class="special"><</span> <span class="identifier">stdin</span><span class="special">)</span><span class="special">;</span> +</pre> +<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>If the launching and the child process use the input, this leads to undefined behaviour.</p></td></tr> +</table></div> +<p> +A syntax like <code class="computeroutput">system("ls", std_out > std::cerr)</code> is not possible, due to the C++ implementation not providing access to the handle.</p> +<p>The valid expressions for this property are</p> +<pre class="programlisting"><span class="identifier">std_out</span> <span class="special"><</span> <span class="identifier">file</span><span class="special">;</span> +<span class="identifier">std_out</span> <span class="special">=</span> <span class="identifier">file</span><span class="special">;</span> +</pre> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdout_pipe"></a>Pipe Output</h3></div></div></div> +<p>As explained in the corresponding section, the boost.process library provides a <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> class which can be used to communicate with child processes.</p> +<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>Technically the <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> works like a synchronous pipe here, since no asio implementation is used by the library here. The asynchronous operation will then however not end if the process is finished, since the pipe remains open. You can use the async_close function with on_exit to fix that.</p></td></tr> +</table></div> +<p> +Valid expressions with pipes are these:</p> +<pre class="programlisting"><span class="identifier">std_out</span> <span class="special">></span> <span class="identifier">pipe</span><span class="special">;</span> +<span class="identifier">std_out</span> <span class="special">=</span> <span class="identifier">pipe</span><span class="special">;</span> +</pre> +<p>Where the valid types for <code class="computeroutput">pipe</code> are the following:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a></code></p></li> +<li class="listitem"><p><code class="computeroutput"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a></code></p></li> +<li class="listitem"><p><code class="computeroutput"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a></code></p></li> +<li class="listitem"><p><code class="computeroutput"><a class="link" href="basic_pstream.html" title="Class template basic_pstream">basic_pstream</a></code></p></li> +</ul></div> +<p> +</p> +<p>Note that the pipe may also be used between several processes, like this:</p> +<pre class="programlisting"><span class="identifier">pipe</span> <span class="identifier">p</span><span class="special">;</span> +<span class="identifier">child</span> <span class="identifier">c1</span><span class="special">(</span><span class="string">"nm"</span><span class="special">,</span> <span class="string">"a.out"</span><span class="special">,</span> <span class="identifier">std_out</span><span class="special">></span><span class="identifier">p</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">child</span> <span class="identifier">c2</span><span class="special">(</span><span class="string">"c++filt"</span><span class="special">,</span> <span class="identifier">std_in</span><span class="special"><</span><span class="identifier">p</span><span class="special">)</span><span class="special">;</span> +</pre> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdout_async_pipe"></a>Asynchronous Pipe Output</h3></div></div></div> +<p>Asynchronous Pipe I/O classifies communication which has automatically handling of the async operations by the process library. This means, that a pipe will be constructed, the async_read/-write will be automatically started, and that the end of the child process will also close the pipe.</p> +<p>Valid types for pipe I/O are the following:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">boost::asio::mutable_buffer</code> <a href="#ftn.idp436648624" class="footnote" name="idp436648624"><sup class="footnote">[26]</sup></a> </p></li> +<li class="listitem"><p><code class="computeroutput">boost::asio::streambuf</code></p></li> +<li class="listitem"><p><code class="computeroutput">std::future<std::vector<char>></code></p></li> +<li class="listitem"><p><code class="computeroutput">std::future<std::string></code></p></li> +</ul></div> +<p> +</p> +<p>Valid expressions with pipes are these:</p> +<pre class="programlisting"><span class="identifier">std_out</span> <span class="special">></span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="identifier">std_out</span> <span class="special">=</span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="identifier">std_err</span> <span class="special">></span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="identifier">std_err</span> <span class="special">=</span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="special">(</span><span class="identifier">std_out</span> <span class="special">&</span> <span class="identifier">std_err</span><span class="special">)</span> <span class="special">></span> <span class="identifier">buffer</span><span class="special">;</span> +<span class="special">(</span><span class="identifier">std_out</span> <span class="special">&</span> <span class="identifier">std_err</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">buffer</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><code class="computeroutput">boost::asio::buffer</code> is also available in the <code class="computeroutput">boost::process</code> namespace.</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>This feature requires <code class="computeroutput">boost/process/async.hpp</code> to be included and a reference to <code class="computeroutput">boost::asio::io_service</code> to be passed to the launching function.</p></td></tr> +</table></div> +<p> +</p> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdout_close"></a>Close</h3></div></div></div> +<p>The out stream can be closed, so it cannot be write from. This will lead to an error when attempted.</p> +<p>This can be achieved by the following syntax.</p> +<pre class="programlisting"><span class="identifier">std_out</span> <span class="special">></span> <span class="identifier">close</span><span class="special">;</span> +<span class="identifier">std_out</span> <span class="special">=</span> <span class="identifier">close</span><span class="special">;</span> +<span class="identifier">std_out</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +</pre> +</div> +<div class="sect2"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="namespaceboost_1_1process_1stdout_null"></a>Null</h3></div></div></div> +<p>The output stream can be redirected to write to the null-device, which means that all output is discarded.</p> +<p>The syntax to achieve that has the following variants:</p> +<pre class="programlisting"><span class="identifier">std_out</span> <span class="special">></span> <span class="identifier">null</span><span class="special">;</span> +<span class="identifier">std_out</span> <span class="special">=</span> <span class="identifier">null</span><span class="special">;</span> +<span class="identifier">std_out</span><span class="special">.</span><span class="identifier">null</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +</pre> +<p> </p> +</div> +</div> +</div> +<div class="footnotes"> +<br><hr style="width:100; text-align:left;margin-left: 0"> +<div id="ftn.idp436648624" class="footnote"><p><a href="#idp436648624" class="para"><sup class="para">[26] </sup></a> Constructed with <code class="computeroutput">boost::asio::buffer</code></p></div> +</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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="std_in.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.io_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="std_err.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/system.html b/doc/html/boost/process/system.html new file mode 100644 index 0000000000..94034e7a45 --- /dev/null +++ b/doc/html/boost/process/system.html @@ -0,0 +1,67 @@ +<!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>Function template system</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.system_hpp" title="Header <boost/process/system.hpp>"> +<link rel="prev" href="start_dir.html" title="Global start_dir"> +<link rel="next" href="windows/hide.html" title="Global hide"> +</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="start_dir.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.system_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="windows/hide.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.system"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template system</span></h2> +<p>boost::process::system</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: <<a class="link" href="../../process/reference.html#header.boost.process.system_hpp" title="Header <boost/process/system.hpp>">boost/process/system.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> <span class="keyword">int</span> <span class="identifier">system</span><span class="special">(</span><span class="identifier">Args</span> <span class="special">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp438318144"></a><h2>Description</h2> +<p>Launches a process and waits for its exit. It works as std::system, though it allows all the properties boost.process provides. It will execute the process and wait for it's exit; then return the exit_code.</p> +<pre class="programlisting"><span class="keyword">int</span> <span class="identifier">ret</span> <span class="special">=</span> <span class="identifier">system</span><span class="special">(</span><span class="string">"ls"</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>Using this function with synchronous pipes leads to many potential deadlocks.</p></td></tr> +</table></div> +<p> +When using this function with an asynchronous properties and NOT passing an io_service object, the system function will create one and run it. When the io_service is passed to the function, the system function will check if it is active, and call the io_service::run function if not. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="start_dir.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.system_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="windows/hide.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/throw_on_error.html b/doc/html/boost/process/throw_on_error.html new file mode 100644 index 0000000000..5fd512260b --- /dev/null +++ b/doc/html/boost/process/throw_on_error.html @@ -0,0 +1,55 @@ +<!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 throw_on_error</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.error_hpp" title="Header <boost/process/error.hpp>"> +<link rel="prev" href="ignore_error.html" title="Global ignore_error"> +<link rel="next" href="error.html" title="Global error"> +</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="ignore_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.throw_on_error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global throw_on_error</span></h2> +<p>boost::process::throw_on_error</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: <<a class="link" href="../../process/reference.html#header.boost.process.error_hpp" title="Header <boost/process/error.hpp>">boost/process/error.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> throw_on_error<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp434869200"></a><h2>Description</h2> +<p>The throw_on_error property will enable the exception when launching a process. It is unnecessary by default, but may be used, when an additional error_code is provided. </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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="ignore_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.error_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="error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/windows/hide.html b/doc/html/boost/process/windows/hide.html new file mode 100644 index 0000000000..3c2070c516 --- /dev/null +++ b/doc/html/boost/process/windows/hide.html @@ -0,0 +1,51 @@ +<!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 hide</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.windows_hpp" title="Header <boost/process/windows.hpp>"> +<link rel="prev" href="../system.html" title="Function template system"> +<link rel="next" href="maximized.html" title="Global maximized"> +</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="../system.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="maximized.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.windows.hide"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global hide</span></h2> +<p>boost::process::windows::hide — Hides the window and activates another window. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.windows_hpp" title="Header <boost/process/windows.hpp>">boost/process/windows.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> hide<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="../system.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="maximized.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/windows/maximized.html b/doc/html/boost/process/windows/maximized.html new file mode 100644 index 0000000000..34a922e516 --- /dev/null +++ b/doc/html/boost/process/windows/maximized.html @@ -0,0 +1,51 @@ +<!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 maximized</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.windows_hpp" title="Header <boost/process/windows.hpp>"> +<link rel="prev" href="hide.html" title="Global hide"> +<link rel="next" href="minimized.html" title="Global minimized"> +</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="hide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="minimized.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.windows.maximized"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global maximized</span></h2> +<p>boost::process::windows::maximized — Activates the window and displays it as a maximized window. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.windows_hpp" title="Header <boost/process/windows.hpp>">boost/process/windows.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> maximized<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="hide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="minimized.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/windows/minimized.html b/doc/html/boost/process/windows/minimized.html new file mode 100644 index 0000000000..4005a0a4cc --- /dev/null +++ b/doc/html/boost/process/windows/minimized.html @@ -0,0 +1,51 @@ +<!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 minimized</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.windows_hpp" title="Header <boost/process/windows.hpp>"> +<link rel="prev" href="maximized.html" title="Global maximized"> +<link rel="next" href="minimized_not_active.html" title="Global minimized_not_active"> +</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="maximized.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="minimized_not_active.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.windows.minimized"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global minimized</span></h2> +<p>boost::process::windows::minimized — Activates the window and displays it as a minimized window. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.windows_hpp" title="Header <boost/process/windows.hpp>">boost/process/windows.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> minimized<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="maximized.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="minimized_not_active.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/windows/minimized_not_active.html b/doc/html/boost/process/windows/minimized_not_active.html new file mode 100644 index 0000000000..48d1cc9e4d --- /dev/null +++ b/doc/html/boost/process/windows/minimized_not_active.html @@ -0,0 +1,51 @@ +<!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 minimized_not_active</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.windows_hpp" title="Header <boost/process/windows.hpp>"> +<link rel="prev" href="minimized.html" title="Global minimized"> +<link rel="next" href="not_active.html" title="Global not_active"> +</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="minimized.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="not_active.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.windows.minimized_not_active"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global minimized_not_active</span></h2> +<p>boost::process::windows::minimized_not_active — Displays the window as a minimized window. This value is similar to <code class="computeroutput">minimized</code>, except the window is not activated. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.windows_hpp" title="Header <boost/process/windows.hpp>">boost/process/windows.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> minimized_not_active<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="minimized.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="not_active.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/windows/not_active.html b/doc/html/boost/process/windows/not_active.html new file mode 100644 index 0000000000..34d4afe0a9 --- /dev/null +++ b/doc/html/boost/process/windows/not_active.html @@ -0,0 +1,51 @@ +<!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 not_active</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.windows_hpp" title="Header <boost/process/windows.hpp>"> +<link rel="prev" href="minimized_not_active.html" title="Global minimized_not_active"> +<link rel="next" href="show.html" title="Global show"> +</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="minimized_not_active.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="show.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.windows.not_active"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global not_active</span></h2> +<p>boost::process::windows::not_active — Displays a window in its most recent size and position. This value is similar to show_normal`, except that the window is not activated. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.windows_hpp" title="Header <boost/process/windows.hpp>">boost/process/windows.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> not_active<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="minimized_not_active.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="show.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/windows/show.html b/doc/html/boost/process/windows/show.html new file mode 100644 index 0000000000..62147c484f --- /dev/null +++ b/doc/html/boost/process/windows/show.html @@ -0,0 +1,51 @@ +<!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 show</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.windows_hpp" title="Header <boost/process/windows.hpp>"> +<link rel="prev" href="not_active.html" title="Global not_active"> +<link rel="next" href="show_normal.html" title="Global show_normal"> +</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="not_active.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="show_normal.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.windows.show"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global show</span></h2> +<p>boost::process::windows::show — Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.windows_hpp" title="Header <boost/process/windows.hpp>">boost/process/windows.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> show<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="not_active.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="show_normal.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/process/windows/show_normal.html b/doc/html/boost/process/windows/show_normal.html new file mode 100644 index 0000000000..05ff91ddd1 --- /dev/null +++ b/doc/html/boost/process/windows/show_normal.html @@ -0,0 +1,51 @@ +<!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 show_normal</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.windows_hpp" title="Header <boost/process/windows.hpp>"> +<link rel="prev" href="show.html" title="Global show"> +<link rel="next" href="../../../boost_process/acknowledgements.html" title="Acknowledgements"> +</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="show.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="../../../boost_process/acknowledgements.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.windows.show_normal"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global show_normal</span></h2> +<p>boost::process::windows::show_normal — Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time. </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: <<a class="link" href="../../../process/reference.html#header.boost.process.windows_hpp" title="Header <boost/process/windows.hpp>">boost/process/windows.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> show_normal<span class="special">;</span></pre></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 © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 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="show.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.windows_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="../../../boost_process/acknowledgements.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |