doc/html/boost/process/basic_pipe.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Class template basic_pipe</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header &lt;boost/process/pipe.hpp&gt;">
  10 <link rel="prev" href="basic_opstream.html" title="Class template basic_opstream">
  11 <link rel="next" href="basic_pipebuf.html" title="Struct template basic_pipebuf">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <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>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.process.basic_pipe"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template basic_pipe</span></h2>
  30 <p>boost::process::basic_pipe</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header &lt;boost/process/pipe.hpp&gt;">boost/process/pipe.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</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">&lt;</span><span class="identifier">CharT</span><span class="special">&gt;</span> <span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// types</span>
  39   <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>
  40   <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>
  41   <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>
  42   <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>
  43   <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>
  44   <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>
  45
  46   <span class="comment">// <a class="link" href="basic_pipe.html#boost.process.basic_pipeconstruct-copy-destruct">construct/copy/destruct</a></span>
  47   <a class="link" href="basic_pipe.html#idm45170604408560-bb"><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  48   <span class="keyword">explicit</span> <a class="link" href="basic_pipe.html#idm45170604407952-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  49   <a class="link" href="basic_pipe.html#idm45170604406400-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <a class="link" href="basic_pipe.html#idm45170604403792-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">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  51   <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&amp;</span> <a class="link" href="basic_pipe.html#idm45170604402096-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  52   <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&amp;</span> <a class="link" href="basic_pipe.html#idm45170604398928-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">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  53   <a class="link" href="basic_pipe.html#idm45170604396672-bb"><span class="special">~</span><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  54
  55   <span class="comment">// <a class="link" href="basic_pipe.html#idm45170604423664-bb">public member functions</a></span>
  56   <span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idm45170604423104-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>
  57   <span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idm45170604421552-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>
  58   <span class="keyword">void</span> <a class="link" href="basic_pipe.html#idm45170604420000-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>
  59   <span class="keyword">void</span> <a class="link" href="basic_pipe.html#idm45170604418032-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>
  60   <span class="identifier">int_type</span> <a class="link" href="basic_pipe.html#idm45170604416064-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>
  61   <span class="identifier">int_type</span> <a class="link" href="basic_pipe.html#idm45170604413536-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>
  62   <span class="keyword">bool</span> <a class="link" href="basic_pipe.html#idm45170604411008-bb"><span class="identifier">is_open</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  63   <span class="keyword">void</span> <a class="link" href="basic_pipe.html#idm45170604409856-bb"><span class="identifier">close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  64 <span class="special">}</span><span class="special">;</span></pre></div>
  65 <div class="refsect1">
  66 <a name="id-1.3.31.9.18.5.4"></a><h2>Description</h2>
  67 <p>Class implementation of a pipe. </p>
  68 <div class="refsect2">
  69 <a name="id-1.3.31.9.18.5.4.3"></a><h3>
  70 <a name="boost.process.basic_pipeconstruct-copy-destruct"></a><code class="computeroutput">basic_pipe</code>
  71         public
  72        construct/copy/destruct</h3>
  73 <div class="orderedlist"><ol class="orderedlist" type="1">
  74 <li class="listitem">
  75 <pre class="literallayout"><a name="idm45170604408560-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>
  76 <li class="listitem">
  77 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45170604407952-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">&amp;</span> name<span class="special">)</span><span class="special">;</span></pre>Construct a named pipe. </li>
  78 <li class="listitem">
  79 <pre class="literallayout"><a name="idm45170604406400-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">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>
  80 <p>Copy construct the pipe. </p>
  81 <div class="note"><table border="0" summary="Note">
  82 <tr>
  83 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  84 <th align="left">Note</th>
  85 </tr>
  86 <tr><td align="left" valign="top"><p>Duplicated the handles. </p></td></tr>
  87 </table></div>
  88 <p>
  89 </p>
  90 </li>
  91 <li class="listitem">
  92 <pre class="literallayout"><a name="idm45170604403792-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">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>
  93 <p>Move construct the pipe. </p>
  94 </li>
  95 <li class="listitem">
  96 <pre class="literallayout"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&amp;</span> <a name="idm45170604402096-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">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>
  97 <p>Copy assign the pipe. </p>
  98 <div class="note"><table border="0" summary="Note">
  99 <tr>
 100 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 101 <th align="left">Note</th>
 102 </tr>
 103 <tr><td align="left" valign="top"><p>Duplicated the handles. </p></td></tr>
 104 </table></div>
 105 <p>
 106 </p>
 107 </li>
 108 <li class="listitem">
 109 <pre class="literallayout"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&amp;</span> <a name="idm45170604398928-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">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>
 110 <p>Move assign the pipe. </p>
 111 </li>
 112 <li class="listitem">
 113 <pre class="literallayout"><a name="idm45170604396672-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>
 114 <p>Destructor closes the handles. </p>
 115 </li>
 116 </ol></div>
 117 </div>
 118 <div class="refsect2">
 119 <a name="id-1.3.31.9.18.5.4.4"></a><h3>
 120 <a name="idm45170604423664-bb"></a><code class="computeroutput">basic_pipe</code> public member functions</h3>
 121 <div class="orderedlist"><ol class="orderedlist" type="1">
 122 <li class="listitem">
 123 <pre class="literallayout"><span class="identifier">native_handle</span> <a name="idm45170604423104-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>
 124 <p>Get the native handle of the source. </p>
 125 </li>
 126 <li class="listitem">
 127 <pre class="literallayout"><span class="identifier">native_handle</span> <a name="idm45170604421552-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>
 128 <p>Get the native handle of the sink. </p>
 129 </li>
 130 <li class="listitem">
 131 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170604420000-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>
 132 <p>Assign a new value to the source </p>
 133 </li>
 134 <li class="listitem">
 135 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170604418032-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>
 136 <p>Assign a new value to the sink </p>
 137 </li>
 138 <li class="listitem">
 139 <pre class="literallayout"><span class="identifier">int_type</span> <a name="idm45170604416064-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>
 140 <li class="listitem">
 141 <pre class="literallayout"><span class="identifier">int_type</span> <a name="idm45170604413536-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>
 142 <li class="listitem">
 143 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45170604411008-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>
 144 <li class="listitem">
 145 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170604409856-bb"></a><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Close the pipe. </li>
 146 </ol></div>
 147 </div>
 148 </div>
 149 </div>
 150 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 151 <td align="left"></td>
 152 <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
 153       Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright &#169; 2016 Klemens D. Morgenstern<p>
 154         Distributed under the Boost Software License, Version 1.0. (See accompanying
 155         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 156       </p>
 157 </div></td>
 158 </tr></table>
 159 <hr>
 160 <div class="spirit-nav">
 161 <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>
 162 </div>
 163 </body>
 164 </html>