diff options
Diffstat (limited to 'doc/html/boost/process/basic_pipe.html')
| -rw-r--r-- | doc/html/boost/process/basic_pipe.html | 82 |
1 files changed, 40 insertions, 42 deletions
diff --git a/doc/html/boost/process/basic_pipe.html b/doc/html/boost/process/basic_pipe.html index 47e24aa595..7ac87c3708 100644 --- a/doc/html/boost/process/basic_pipe.html +++ b/doc/html/boost/process/basic_pipe.html @@ -9,6 +9,7 @@ <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="basic_pipebuf.html" title="Struct template basic_pipebuf"> +<meta name="viewport" content="width=device-width, initial-scale=1"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -29,8 +30,8 @@ <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>> +<h2 class="refsynopsisdiv-title">Synopsis</h2> +<div 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> @@ -44,39 +45,39 @@ <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#idm45512231330688-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#idm45512231330080-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#idm45512231328528-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#idm45512231325920-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#idm45512231324224-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#idm45512231321056-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#idm45512231318800-bb"><span class="special">~</span><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_pipe.html#idm4616-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#idm4618-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#idm4622-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="../circular_buffer.html#idm4630-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#idm4636-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#idm4646-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="../container/private_adaptive_pool.html#idm4654-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#idm45512231345792-bb">public member functions</a></span> - <span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idm45512231345232-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#idm45512231343680-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#idm45512231342128-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#idm45512231340160-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#idm45512231338192-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#idm45512231335664-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#idm45512231333136-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#idm45512231331984-bb"><span class="identifier">close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_pipe.html#idm4575-bb">public member functions</a></span> + <span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idm4576-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="../container/private_adaptive_pool.html#idm4580-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#idm4584-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="../container/private_adaptive_pool.html#idm4590-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="../circular_buffer.html#idm4596-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#idm4603-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="../container/private_adaptive_pool.html#idm4610-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="../dll/shared_library.html#idm4613-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="id-1.3.31.9.18.5.4"></a><h2>Description</h2> +<a name="id-1.3.29.10.20.5.4"></a><h2>Description</h2> <p>Class implementation of a pipe. </p> <div class="refsect2"> -<a name="id-1.3.31.9.18.5.4.3"></a><h3> +<a name="id-1.3.29.10.20.5.4.3"></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="idm45512231330688-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> +<pre class="literallayout"><a name="idm4616-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="idm45512231330080-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> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm4618-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="idm45512231328528-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> +<pre class="literallayout"><a name="idm4622-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> @@ -89,11 +90,11 @@ </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idm45512231325920-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> +<pre class="literallayout"><a name="idm4630-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="idm45512231324224-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> +<pre class="literallayout"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a name="idm4636-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> @@ -106,56 +107,53 @@ </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="idm45512231321056-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> +<pre class="literallayout"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a name="idm4646-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="idm45512231318800-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> +<pre class="literallayout"><a name="idm4654-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="id-1.3.31.9.18.5.4.4"></a><h3> -<a name="idm45512231345792-bb"></a><code class="computeroutput">basic_pipe</code> public member functions</h3> +<a name="id-1.3.29.10.20.5.4.4"></a><h3> +<a name="idm4575-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="idm45512231345232-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> +<pre class="literallayout"><span class="identifier">native_handle</span> <a name="idm4576-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="idm45512231343680-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> +<pre class="literallayout"><span class="identifier">native_handle</span> <a name="idm4580-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="idm45512231342128-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idm4584-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="idm45512231340160-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idm4590-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="idm45512231338192-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> +<pre class="literallayout"><span class="identifier">int_type</span> <a name="idm4596-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="idm45512231335664-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> +<pre class="literallayout"><span class="identifier">int_type</span> <a name="idm4603-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="idm45512231333136-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> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idm4610-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="idm45512231331984-bb"></a><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Close the pipe. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idm4613-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, +<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> +</div> <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="basic_pipebuf.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |