1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Stream-Oriented HANDLEs</title> 5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../windows.html" title="Windows-Specific Functionality"> 9<link rel="prev" href="../windows.html" title="Windows-Specific Functionality"> 10<link rel="next" href="random_access_handle.html" title="Random-Access HANDLEs"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="../windows.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="random_access_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="boost_asio.overview.windows.stream_handle"></a><a class="link" href="stream_handle.html" title="Stream-Oriented HANDLEs">Stream-Oriented 28 HANDLEs</a> 29</h4></div></div></div> 30<p> 31 Boost.Asio contains classes to allow asynchronous read and write operations 32 to be performed on Windows <code class="computeroutput">HANDLE</code>s, such as named pipes. 33 </p> 34<p> 35 For example, to perform asynchronous operations on a named pipe, the following 36 object may be created: 37 </p> 38<pre class="programlisting">HANDLE handle = ::CreateFile(...); 39windows::stream_handle pipe(my_io_context, handle); 40</pre> 41<p> 42 These are then used as synchronous or asynchronous read and write streams. 43 This means the objects can be used with any of the <a class="link" href="../../reference/read.html" title="read">read()</a>, 44 <a class="link" href="../../reference/async_read.html" title="async_read">async_read()</a>, <a class="link" href="../../reference/write.html" title="write">write()</a>, <a class="link" href="../../reference/async_write.html" title="async_write">async_write()</a>, 45 <a class="link" href="../../reference/read_until.html" title="read_until">read_until()</a> or 46 <a class="link" href="../../reference/async_read_until.html" title="async_read_until">async_read_until()</a> 47 free functions. 48 </p> 49<p> 50 The kernel object referred to by the <code class="computeroutput">HANDLE</code> must support use 51 with I/O completion ports (which means that named pipes are supported, 52 but anonymous pipes and console streams are not). 53 </p> 54<h6> 55<a name="boost_asio.overview.windows.stream_handle.h0"></a> 56 <span class="phrase"><a name="boost_asio.overview.windows.stream_handle.see_also"></a></span><a class="link" href="stream_handle.html#boost_asio.overview.windows.stream_handle.see_also">See Also</a> 57 </h6> 58<p> 59 <a class="link" href="../../reference/windows__stream_handle.html" title="windows::stream_handle">windows::stream_handle</a>. 60 </p> 61<h6> 62<a name="boost_asio.overview.windows.stream_handle.h1"></a> 63 <span class="phrase"><a name="boost_asio.overview.windows.stream_handle.notes"></a></span><a class="link" href="stream_handle.html#boost_asio.overview.windows.stream_handle.notes">Notes</a> 64 </h6> 65<p> 66 Windows stream <code class="computeroutput">HANDLE</code>s are only available at compile time 67 when targeting Windows and only when the I/O completion port backend is 68 used (which is the default). A program may test for the macro <code class="computeroutput">BOOST_ASIO_HAS_WINDOWS_STREAM_HANDLE</code> 69 to determine whether they are supported. 70 </p> 71</div> 72<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 73<td align="left"></td> 74<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 75 Kohlhoff<p> 76 Distributed under the Boost Software License, Version 1.0. (See accompanying 77 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 78 </p> 79</div></td> 80</tr></table> 81<hr> 82<div class="spirit-nav"> 83<a accesskey="p" href="../windows.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="random_access_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 84</div> 85</body> 86</html> 87
