doc/html/boost/process/async_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 async_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.async_pipe_hpp" title="Header &lt;boost/process/async_pipe.hpp&gt;">
  10 <link rel="prev" href="on_exit.html" title="Global on_exit">
  11 <link rel="next" href="async_system.html" title="Function template async_system">
  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="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>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.process.async_pipe"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class async_pipe</span></h2>
  30 <p>boost::process::async_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.async_pipe_hpp" title="Header &lt;boost/process/async_pipe.hpp&gt;">boost/process/async_pipe.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">class</span> <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// <a class="link" href="async_pipe.html#boost.process.async_pipetypes">types</a></span>
  39   <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>
  40   <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>
  41
  42   <span class="comment">// <a class="link" href="async_pipe.html#boost.process.async_pipeconstruct-copy-destruct">construct/copy/destruct</a></span>
  43   <a class="link" href="async_pipe.html#idm45170605318368-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_context</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44   <a class="link" href="async_pipe.html#idm45170605315632-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_context</span> <span class="special">&amp;</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_context</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45   <a class="link" href="async_pipe.html#idm45170605312384-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_context</span> <span class="special">&amp;</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><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="async_pipe.html#idm45170605309008-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_context</span> <span class="special">&amp;</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_context</span> <span class="special">&amp;</span><span class="special">,</span>
  47              <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>
  48   <a class="link" href="async_pipe.html#idm45170605305104-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  49   <a class="link" href="async_pipe.html#idm45170605302704-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">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <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>
  51     <span class="keyword">explicit</span> <a class="link" href="async_pipe.html#idm45170605301184-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_context</span> <span class="special">&amp;</span><span class="special">,</span>
  52                         <span class="keyword">const</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> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  53   <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>
  54     <span class="keyword">explicit</span> <a class="link" href="async_pipe.html#idm45170605296416-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_context</span> <span class="special">&amp;</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_context</span> <span class="special">&amp;</span><span class="special">,</span>
  55                         <span class="keyword">const</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> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  56   <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>
  57     <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&amp;</span> <a class="link" href="async_pipe.html#idm45170605290928-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">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  58   <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&amp;</span> <a class="link" href="async_pipe.html#idm45170605285888-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  59   <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&amp;</span> <a class="link" href="async_pipe.html#idm45170605283088-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">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  60   <a class="link" href="async_pipe.html#idm45170605281056-bb"><span class="special">~</span><span class="identifier">async_pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  61
  62   <span class="comment">// <a class="link" href="async_pipe.html#idm45170605363520-bb">public member functions</a></span>
  63   <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>
  64     <span class="keyword">explicit</span> <a class="link" href="async_pipe.html#idm45170605363024-bb"><span class="keyword">operator</span> <span class="identifier">basic_pipe</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></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="async_pipe.html#idm45170605359280-bb"><span class="identifier">cancel</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  66   <span class="keyword">void</span> <a class="link" href="async_pipe.html#idm45170605358144-bb"><span class="identifier">close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  67   <span class="keyword">void</span> <a class="link" href="async_pipe.html#idm45170605357008-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  68   <span class="keyword">bool</span> <a class="link" href="async_pipe.html#idm45170605355248-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>
  69   <span class="keyword">void</span> <a class="link" href="async_pipe.html#idm45170605353872-bb"><span class="identifier">async_close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  70   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">&gt;</span>
  71     <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="async_pipe.html#idm45170605351888-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  72   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">&gt;</span>
  73     <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="async_pipe.html#idm45170605349120-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  74   <span class="identifier">native_handle</span> <a class="link" href="async_pipe.html#idm45170605346352-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>
  75   <span class="identifier">native_handle</span> <a class="link" href="async_pipe.html#idm45170605344976-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>
  76   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">,</span> <span class="keyword">typename</span> ReadHandler<span class="special">&gt;</span>
  77     <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="async_pipe.html#idm45170605343600-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">&amp;</span><span class="special">,</span> <span class="identifier">ReadHandler</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  78   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ConstBufferSequence<span class="special">,</span> <span class="keyword">typename</span> WriteHandler<span class="special">&gt;</span>
  79     <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="async_pipe.html#idm45170605338864-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">&amp;</span><span class="special">,</span> <span class="identifier">WriteHandler</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  80   <span class="keyword">const</span> <span class="identifier">handle_type</span> <span class="special">&amp;</span> <a class="link" href="async_pipe.html#idm45170605334112-bb"><span class="identifier">sink</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  81   <span class="keyword">const</span> <span class="identifier">handle_type</span> <span class="special">&amp;</span> <a class="link" href="async_pipe.html#idm45170605332864-bb"><span class="identifier">source</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  82   <span class="identifier">handle_type</span> <span class="special">&amp;&amp;</span> <a class="link" href="async_pipe.html#idm45170605331616-bb"><span class="identifier">sink</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  83   <span class="identifier">handle_type</span> <span class="special">&amp;&amp;</span> <a class="link" href="async_pipe.html#idm45170605330528-bb"><span class="identifier">source</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  84   <span class="identifier">handle_type</span> <a class="link" href="async_pipe.html#idm45170605329440-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_context</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  85   <span class="identifier">handle_type</span> <a class="link" href="async_pipe.html#idm45170605326816-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_context</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  86   <span class="identifier">handle_type</span> <a class="link" href="async_pipe.html#idm45170605324192-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_context</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  87   <span class="identifier">handle_type</span> <a class="link" href="async_pipe.html#idm45170605321344-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_context</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  88 <span class="special">}</span><span class="special">;</span></pre></div>
  89 <div class="refsect1">
  90 <a name="id-1.3.31.9.4.3.4"></a><h2>Description</h2>
  91 <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>
  92 <p>It can be used directly with boost::asio::async_read or async_write.</p>
  93 <div class="note"><table border="0" summary="Note">
  94 <tr>
  95 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  96 <th align="left">Note</th>
  97 </tr>
  98 <tr><td align="left" valign="top"><p>The object is copyable, but that does invoke a handle duplicate. </p></td></tr>
  99 </table></div>
 100 <p>
 101 </p>
 102 <div class="refsect2">
 103 <a name="id-1.3.31.9.4.3.4.5"></a><h3>
 104 <a name="boost.process.async_pipetypes"></a><code class="computeroutput">async_pipe</code>
 105         public
 106        types</h3>
 107 <div class="orderedlist"><ol class="orderedlist" type="1">
 108 <li class="listitem">
 109 <p>
 110 <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>
 111 <p>Typedef for the native handle representation. </p>
 112 <div class="note"><table border="0" summary="Note">
 113 <tr>
 114 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 115 <th align="left">Note</th>
 116 </tr>
 117 <tr><td align="left" valign="top"><p>This is the handle on the system, not the boost.asio class. </p></td></tr>
 118 </table></div>
 119 <p>
 120 </p>
 121 </li>
 122 <li class="listitem">
 123 <p>
 124 <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>
 125 <p>Typedef for the handle representation of boost.asio. </p>
 126 </li>
 127 </ol></div>
 128 </div>
 129 <div class="refsect2">
 130 <a name="id-1.3.31.9.4.3.4.6"></a><h3>
 131 <a name="boost.process.async_pipeconstruct-copy-destruct"></a><code class="computeroutput">async_pipe</code>
 132         public
 133        construct/copy/destruct</h3>
 134 <div class="orderedlist"><ol class="orderedlist" type="1">
 135 <li class="listitem">
 136 <pre class="literallayout"><a name="idm45170605318368-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_context</span> <span class="special">&amp;</span> ios<span class="special">)</span><span class="special">;</span></pre>
 137 <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_context. </p>
 138 <div class="note"><table border="0" summary="Note">
 139 <tr>
 140 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 141 <th align="left">Note</th>
 142 </tr>
 143 <tr><td align="left" valign="top"><p>Windows creates a named pipe here, where the name is automatically generated. </p></td></tr>
 144 </table></div>
 145 <p>
 146 </p>
 147 </li>
 148 <li class="listitem">
 149 <pre class="literallayout"><a name="idm45170605315632-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_context</span> <span class="special">&amp;</span> ios_source<span class="special">,</span>
 150            <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_context</span> <span class="special">&amp;</span> ios_sink<span class="special">)</span><span class="special">;</span></pre>
 151 <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>
 152 <div class="note"><table border="0" summary="Note">
 153 <tr>
 154 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 155 <th align="left">Note</th>
 156 </tr>
 157 <tr><td align="left" valign="top"><p>Windows creates a named pipe here, where the name is automatically generated. </p></td></tr>
 158 </table></div>
 159 <p>
 160 </p>
 161 </li>
 162 <li class="listitem">
 163 <pre class="literallayout"><a name="idm45170605312384-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_context</span> <span class="special">&amp;</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">&amp;</span> name<span class="special">)</span><span class="special">;</span></pre>
 164 <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_context.</p>
 165 <div class="note"><table border="0" summary="Note">
 166 <tr>
 167 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 168 <th align="left">Note</th>
 169 </tr>
 170 <tr><td align="left" valign="top"><p>Windows restricts possible names. </p></td></tr>
 171 </table></div>
 172 <p>
 173 </p>
 174 </li>
 175 <li class="listitem">
 176 <pre class="literallayout"><a name="idm45170605309008-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_context</span> <span class="special">&amp;</span> ios_source<span class="special">,</span>
 177            <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_context</span> <span class="special">&amp;</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">&amp;</span> name<span class="special">)</span><span class="special">;</span></pre>
 178 <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>
 179 <div class="note"><table border="0" summary="Note">
 180 <tr>
 181 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 182 <th align="left">Note</th>
 183 </tr>
 184 <tr><td align="left" valign="top"><p>Windows restricts possible names. </p></td></tr>
 185 </table></div>
 186 <p>
 187 </p>
 188 </li>
 189 <li class="listitem">
 190 <pre class="literallayout"><a name="idm45170605305104-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">&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>
 191 <p>Copy-Constructor of the async pipe. </p>
 192 <div class="note"><table border="0" summary="Note">
 193 <tr>
 194 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 195 <th align="left">Note</th>
 196 </tr>
 197 <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>
 198 </table></div>
 199 <p>
 200 </p>
 201 </li>
 202 <li class="listitem">
 203 <pre class="literallayout"><a name="idm45170605302704-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">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>
 204 <p>Move-Constructor of the async pipe. </p>
 205 </li>
 206 <li class="listitem">
 207 <pre class="literallayout"><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>
 208   <span class="keyword">explicit</span> <a name="idm45170605301184-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_context</span> <span class="special">&amp;</span> ios<span class="special">,</span>
 209                       <span class="keyword">const</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> <span class="special">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>
 210 <p>Construct the async-pipe from a pipe. </p>
 211 <div class="note"><table border="0" summary="Note">
 212 <tr>
 213 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 214 <th align="left">Note</th>
 215 </tr>
 216 <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>
 217 </table></div>
 218 <p>
 219 </p>
 220 </li>
 221 <li class="listitem">
 222 <pre class="literallayout"><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>
 223   <span class="keyword">explicit</span> <a name="idm45170605296416-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_context</span> <span class="special">&amp;</span> ios_source<span class="special">,</span>
 224                       <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_context</span> <span class="special">&amp;</span> ios_sink<span class="special">,</span>
 225                       <span class="keyword">const</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> <span class="special">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>
 226 <p>Construct the async-pipe from a pipe, with two different io_context objects. </p>
 227 <div class="note"><table border="0" summary="Note">
 228 <tr>
 229 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 230 <th align="left">Note</th>
 231 </tr>
 232 <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>
 233 </table></div>
 234 <p>
 235 </p>
 236 </li>
 237 <li class="listitem">
 238 <pre class="literallayout"><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>
 239   <a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&amp;</span> <a name="idm45170605290928-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">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>
 240 <p>Assign a <code class="computeroutput"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a></code>. </p>
 241 <div class="note"><table border="0" summary="Note">
 242 <tr>
 243 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 244 <th align="left">Note</th>
 245 </tr>
 246 <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>
 247 </table></div>
 248 <p>
 249 </p>
 250 </li>
 251 <li class="listitem">
 252 <pre class="literallayout"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&amp;</span> <a name="idm45170605285888-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">&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>
 253 <p>Copy Assign a pipe. </p>
 254 <div class="note"><table border="0" summary="Note">
 255 <tr>
 256 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 257 <th align="left">Note</th>
 258 </tr>
 259 <tr><td align="left" valign="top"><p>Duplicates the handles. </p></td></tr>
 260 </table></div>
 261 <p>
 262 </p>
 263 </li>
 264 <li class="listitem">
 265 <pre class="literallayout"><a class="link" href="async_pipe.html" title="Class async_pipe">async_pipe</a> <span class="special">&amp;</span> <a name="idm45170605283088-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">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>
 266 <p>Move assign a pipe </p>
 267 </li>
 268 <li class="listitem">
 269 <pre class="literallayout"><a name="idm45170605281056-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>
 270 <p>Destructor. Closes the pipe handles. </p>
 271 </li>
 272 </ol></div>
 273 </div>
 274 <div class="refsect2">
 275 <a name="id-1.3.31.9.4.3.4.7"></a><h3>
 276 <a name="idm45170605363520-bb"></a><code class="computeroutput">async_pipe</code> public member functions</h3>
 277 <div class="orderedlist"><ol class="orderedlist" type="1">
 278 <li class="listitem">
 279 <pre class="literallayout"><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>
 280   <span class="keyword">explicit</span> <a name="idm45170605363024-bb"></a><span class="keyword">operator</span> <span class="identifier">basic_pipe</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><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 281 <p>Explicit cast to <code class="computeroutput"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a></code>. </p>
 282 </li>
 283 <li class="listitem">
 284 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605359280-bb"></a><span class="identifier">cancel</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 285 <p>Cancel the current asynchronous operations. </p>
 286 </li>
 287 <li class="listitem">
 288 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605358144-bb"></a><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 289 <p>Close the pipe handles. </p>
 290 </li>
 291 <li class="listitem">
 292 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605357008-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">&amp;</span> ec<span class="special">)</span><span class="special">;</span></pre>
 293 <p>Close the pipe handles. While passing an error_code </p>
 294 </li>
 295 <li class="listitem">
 296 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45170605355248-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>
 297 <p>Check if the pipes are open. </p>
 298 </li>
 299 <li class="listitem">
 300 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605353872-bb"></a><span class="identifier">async_close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 301 <p>Async close, i.e. close after current operation is completed.</p>
 302 <div class="note"><table border="0" summary="Note">
 303 <tr>
 304 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 305 <th align="left">Note</th>
 306 </tr>
 307 <tr><td align="left" valign="top"><p>There is no guarantee that this will indeed read the entire pipe-buffer </p></td></tr>
 308 </table></div>
 309 <p>
 310 </p>
 311 </li>
 312 <li class="listitem">
 313 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">&gt;</span>
 314   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm45170605351888-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">&amp;</span> buffers<span class="special">)</span><span class="special">;</span></pre>
 315 <p>Read some data from the handle.</p>
 316 <p>See the boost.asio documentation for more details. </p>
 317 </li>
 318 <li class="listitem">
 319 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">&gt;</span>
 320   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm45170605349120-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">&amp;</span> buffers<span class="special">)</span><span class="special">;</span></pre>
 321 <p>Write some data to the handle.</p>
 322 <p>See the boost.asio documentation for more details. </p>
 323 </li>
 324 <li class="listitem">
 325 <pre class="literallayout"><span class="identifier">native_handle</span> <a name="idm45170605346352-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>
 326 <p>Get the native handle of the source. </p>
 327 </li>
 328 <li class="listitem">
 329 <pre class="literallayout"><span class="identifier">native_handle</span> <a name="idm45170605344976-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>
 330 <p>Get the native handle of the sink. </p>
 331 </li>
 332 <li class="listitem">
 333 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MutableBufferSequence<span class="special">,</span> <span class="keyword">typename</span> ReadHandler<span class="special">&gt;</span>
 334   <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm45170605343600-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">&amp;</span> buffers<span class="special">,</span>
 335                               <span class="identifier">ReadHandler</span> <span class="special">&amp;&amp;</span> handler<span class="special">)</span><span class="special">;</span></pre>
 336 <p>Start an asynchronous read.</p>
 337 <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>
 338 </li>
 339 <li class="listitem">
 340 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ConstBufferSequence<span class="special">,</span> <span class="keyword">typename</span> WriteHandler<span class="special">&gt;</span>
 341   <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm45170605338864-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">&amp;</span> buffers<span class="special">,</span>
 342                                <span class="identifier">WriteHandler</span> <span class="special">&amp;&amp;</span> handler<span class="special">)</span><span class="special">;</span></pre>
 343 <p>Start an asynchronous write.</p>
 344 <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>
 345 </li>
 346 <li class="listitem">
 347 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">handle_type</span> <span class="special">&amp;</span> <a name="idm45170605334112-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>
 348 <li class="listitem">
 349 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">handle_type</span> <span class="special">&amp;</span> <a name="idm45170605332864-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>
 350 <li class="listitem">
 351 <pre class="literallayout"><span class="identifier">handle_type</span> <span class="special">&amp;&amp;</span> <a name="idm45170605331616-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>
 352 <li class="listitem">
 353 <pre class="literallayout"><span class="identifier">handle_type</span> <span class="special">&amp;&amp;</span> <a name="idm45170605330528-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>
 354 <li class="listitem">
 355 <pre class="literallayout"><span class="identifier">handle_type</span> <a name="idm45170605329440-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_context</span> <span class="special">&amp;</span> ios<span class="special">)</span><span class="special">;</span></pre>Move the source out of this class and change the io_context. Qualified as rvalue. <div class="note"><table border="0" summary="Note">
 356 <tr>
 357 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 358 <th align="left">Note</th>
 359 </tr>
 360 <tr><td align="left" valign="top"><p>Will always move. </p></td></tr>
 361 </table></div>
 362 <p>
 363 </p>
 364 </li>
 365 <li class="listitem">
 366 <pre class="literallayout"><span class="identifier">handle_type</span> <a name="idm45170605326816-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_context</span> <span class="special">&amp;</span> ios<span class="special">)</span><span class="special">;</span></pre>Move the sink out of this class and change the io_context. Qualified as rvalue. <div class="note"><table border="0" summary="Note">
 367 <tr>
 368 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 369 <th align="left">Note</th>
 370 </tr>
 371 <tr><td align="left" valign="top"><p>Will always move </p></td></tr>
 372 </table></div>
 373 <p>
 374 </p>
 375 </li>
 376 <li class="listitem">
 377 <pre class="literallayout"><span class="identifier">handle_type</span> <a name="idm45170605324192-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_context</span> <span class="special">&amp;</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_context. <div class="note"><table border="0" summary="Note">
 378 <tr>
 379 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 380 <th align="left">Note</th>
 381 </tr>
 382 <tr><td align="left" valign="top"><p>Will always copy. </p></td></tr>
 383 </table></div>
 384 <p>
 385 </p>
 386 </li>
 387 <li class="listitem">
 388 <pre class="literallayout"><span class="identifier">handle_type</span> <a name="idm45170605321344-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_context</span> <span class="special">&amp;</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_context. <div class="note"><table border="0" summary="Note">
 389 <tr>
 390 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
 391 <th align="left">Note</th>
 392 </tr>
 393 <tr><td align="left" valign="top"><p>Will always copy </p></td></tr>
 394 </table></div>
 395 <p>
 396 </p>
 397 </li>
 398 </ol></div>
 399 </div>
 400 </div>
 401 </div>
 402 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 403 <td align="left"></td>
 404 <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
 405       Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright &#169; 2016 Klemens D. Morgenstern<p>
 406         Distributed under the Boost Software License, Version 1.0. (See accompanying
 407         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 408       </p>
 409 </div></td>
 410 </tr></table>
 411 <hr>
 412 <div class="spirit-nav">
 413 <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>
 414 </div>
 415 </body>
 416 </html>