diff options
Diffstat (limited to 'doc/html/boost/process/basic_pipe.html')
| -rw-r--r-- | doc/html/boost/process/basic_pipe.html | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/doc/html/boost/process/basic_pipe.html b/doc/html/boost/process/basic_pipe.html index 6bab4c6bf2..5b1261dd13 100644 --- a/doc/html/boost/process/basic_pipe.html +++ b/doc/html/boost/process/basic_pipe.html @@ -44,39 +44,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#idp25331664-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#idp25332272-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#idp25333824-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#idp25336272-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#idp25337968-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#idp25340976-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#idp25343232-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#idp40356896-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#idp40357504-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#idp40359056-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#idp40361504-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#idp40363200-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#idp40366208-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#idp40368464-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#idp25316560-bb">public member functions</a></span> - <span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idp25317120-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#idp25318672-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#idp25320224-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#idp25322192-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#idp25324160-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#idp25326688-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#idp25329216-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#idp25330368-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#idp40341792-bb">public member functions</a></span> + <span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idp40342352-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#idp40343904-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#idp40345456-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#idp40347424-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#idp40349392-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#idp40351920-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#idp40354448-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#idp40355600-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="idp434275328"></a><h2>Description</h2> +<a name="idp418118416"></a><h2>Description</h2> <p>Class implementation of a pipe. </p> <div class="refsect2"> -<a name="idp434276048"></a><h3> +<a name="idp418119136"></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="idp25331664-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="idp40356896-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="idp25332272-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="idp40357504-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="idp25333824-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="idp40359056-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 +89,11 @@ </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp25336272-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="idp40361504-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="idp25337968-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="idp40363200-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,43 +106,43 @@ </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="idp25340976-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="idp40366208-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="idp25343232-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="idp40368464-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="idp434322608"></a><h3> -<a name="idp25316560-bb"></a><code class="computeroutput">basic_pipe</code> public member functions</h3> +<a name="idp418165568"></a><h3> +<a name="idp40341792-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="idp25317120-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="idp40342352-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="idp25318672-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="idp40343904-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="idp25320224-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="idp40345456-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="idp25322192-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="idp40347424-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="idp25324160-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="idp40349392-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="idp25326688-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="idp40351920-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="idp25329216-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="idp40354448-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="idp25330368-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="idp40355600-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> |