doc/html/boost/process/basic_ipstream.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_ipstream</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="std_err.html" title="Global std_err">
  11 <link rel="next" href="basic_opstream.html" title="Class template basic_opstream">
  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="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_opstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.process.basic_ipstream"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template basic_ipstream</span></h2>
  30 <p>boost::process::basic_ipstream</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_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">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <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> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <a name="boost.process.basic_ipstream.pipe_type"></a><span class="identifier">pipe_type</span><span class="special">;</span>
  40   <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>
  41   <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>
  42   <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>
  43   <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>
  44   <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>
  45
  46   <span class="comment">// <a class="link" href="basic_ipstream.html#boost.process.basic_ipstreamconstruct-copy-destruct">construct/copy/destruct</a></span>
  47   <a class="link" href="basic_ipstream.html#idm45170604488736-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  48   <a class="link" href="basic_ipstream.html#idm45170604488160-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">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  49   <a class="link" href="basic_ipstream.html#idm45170604486176-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">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <a class="link" href="basic_ipstream.html#idm45170604484624-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">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  51   <a class="link" href="basic_ipstream.html#idm45170604483056-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  52   <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45170604481328-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">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  53   <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45170604478768-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">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  54   <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45170604476640-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">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  55   <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45170604474496-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  56
  57   <span class="comment">// <a class="link" href="basic_ipstream.html#idm45170604505920-bb">public member functions</a></span>
  58   <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">*</span> <a class="link" href="basic_ipstream.html#idm45170604505360-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45170604503632-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">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  60   <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45170604501504-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  61   <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45170604499216-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  62   <span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45170604497776-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  63   <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span> <a class="link" href="basic_ipstream.html#idm45170604495904-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  64   <span class="keyword">bool</span> <a class="link" href="basic_ipstream.html#idm45170604494432-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>
  65   <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45170604493008-bb"><span class="identifier">open</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  66   <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45170604491872-bb"><span class="identifier">open</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>
  67   <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45170604490048-bb"><span class="identifier">close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  68 <span class="special">}</span><span class="special">;</span></pre></div>
  69 <div class="refsect1">
  70 <a name="id-1.3.31.9.18.3.4"></a><h2>Description</h2>
  71 <p>Implementation of a reading pipe stream. </p>
  72 <div class="refsect2">
  73 <a name="id-1.3.31.9.18.3.4.3"></a><h3>
  74 <a name="boost.process.basic_ipstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_ipstream</code>
  75         public
  76        construct/copy/destruct</h3>
  77 <div class="orderedlist"><ol class="orderedlist" type="1">
  78 <li class="listitem">
  79 <pre class="literallayout"><a name="idm45170604488736-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li>
  80 <li class="listitem">
  81 <pre class="literallayout"><a name="idm45170604488160-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">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy constructor. </li>
  82 <li class="listitem">
  83 <pre class="literallayout"><a name="idm45170604486176-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">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>Move constructor. </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><a name="idm45170604484624-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">&amp;&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Move construct from a pipe. </li>
  86 <li class="listitem">
  87 <pre class="literallayout"><a name="idm45170604483056-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">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Copy construct from a pipe. </li>
  88 <li class="listitem">
  89 <pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a name="idm45170604481328-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">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy assignment. </li>
  90 <li class="listitem">
  91 <pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a name="idm45170604478768-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">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>Move assignment. </li>
  92 <li class="listitem">
  93 <pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a name="idm45170604476640-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">&amp;&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Move assignment of a pipe. </li>
  94 <li class="listitem">
  95 <pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a name="idm45170604474496-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">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Copy assignment of a pipe. </li>
  96 </ol></div>
  97 </div>
  98 <div class="refsect2">
  99 <a name="id-1.3.31.9.18.3.4.4"></a><h3>
 100 <a name="idm45170604505920-bb"></a><code class="computeroutput">basic_ipstream</code> public member functions</h3>
 101 <div class="orderedlist"><ol class="orderedlist" type="1">
 102 <li class="listitem">
 103 <pre class="literallayout"><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">*</span> <a name="idm45170604505360-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>
 104 <li class="listitem">
 105 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170604503632-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">&amp;&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li>
 106 <li class="listitem">
 107 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170604501504-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">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li>
 108 <li class="listitem">
 109 <pre class="literallayout"><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> <a name="idm45170604499216-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>
 110 <li class="listitem">
 111 <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">&amp;</span> <a name="idm45170604497776-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>
 112 <li class="listitem">
 113 <pre class="literallayout"><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span> <a name="idm45170604495904-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>
 114 <li class="listitem">
 115 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45170604494432-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>Check if the pipe is open. </li>
 116 <li class="listitem">
 117 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170604493008-bb"></a><span class="identifier">open</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Open a new pipe. </li>
 118 <li class="listitem">
 119 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170604491872-bb"></a><span class="identifier">open</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>Open a new named pipe. </li>
 120 <li class="listitem">
 121 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170604490048-bb"></a><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Flush the buffer &amp; close the pipe. </li>
 122 </ol></div>
 123 </div>
 124 </div>
 125 </div>
 126 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 127 <td align="left"></td>
 128 <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
 129       Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright &#169; 2016 Klemens D. Morgenstern<p>
 130         Distributed under the Boost Software License, Version 1.0. (See accompanying
 131         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 132       </p>
 133 </div></td>
 134 </tr></table>
 135 <hr>
 136 <div class="spirit-nav">
 137 <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_opstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 138 </div>
 139 </body>
 140 </html>