<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>windows::basic_stream_handle</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../boost_asio.html" title="Boost.Asio"> <link rel="up" href="../reference.html" title="Reference"> <link rel="prev" href="windows__basic_random_access_handle__rebind_executor/other.html" title="windows::basic_random_access_handle::rebind_executor::other"> <link rel="next" href="windows__basic_stream_handle/assign.html" title="windows::basic_stream_handle::assign"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> <td align="center"><a href="../../../../index.html">Home</a></td> <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="windows__basic_random_access_handle__rebind_executor/other.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="windows__basic_stream_handle/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> <a name="boost_asio.reference.windows__basic_stream_handle"></a><a class="link" href="windows__basic_stream_handle.html" title="windows::basic_stream_handle">windows::basic_stream_handle</a> </h3></div></div></div> <p> <a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle"></a> </p> <p> Provides stream-oriented handle functionality. </p> <pre class="programlisting">template< typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a> = any_io_executor> class basic_stream_handle : public windows::basic_overlapped_handle< Executor > </pre> <h5> <a name="boost_asio.reference.windows__basic_stream_handle.h0"></a> <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.types"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.types">Types</a> </h5> <div class="informaltable"><table class="table"> <colgroup> <col> <col> </colgroup> <thead><tr> <th> <p> Name </p> </th> <th> <p> Description </p> </th> </tr></thead> <tbody> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle__rebind_executor.html" title="windows::basic_stream_handle::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a> </p> </td> <td> <p> Rebinds the handle type to another executor. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/executor_type.html" title="windows::basic_stream_handle::executor_type"><span class="bold"><strong>executor_type</strong></span></a> </p> </td> <td> <p> The type of the executor associated with the object. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/lowest_layer_type.html" title="windows::basic_stream_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a> </p> </td> <td> <p> An overlapped_handle is always the lowest layer. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/native_handle_type.html" title="windows::basic_stream_handle::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a> </p> </td> <td> <p> The native representation of a handle. </p> </td> </tr> </tbody> </table></div> <h5> <a name="boost_asio.reference.windows__basic_stream_handle.h1"></a> <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.member_functions"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.member_functions">Member Functions</a> </h5> <div class="informaltable"><table class="table"> <colgroup> <col> <col> </colgroup> <thead><tr> <th> <p> Name </p> </th> <th> <p> Description </p> </th> </tr></thead> <tbody> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/assign.html" title="windows::basic_stream_handle::assign"><span class="bold"><strong>assign</strong></span></a> </p> </td> <td> <p> Assign an existing native handle to the handle. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/async_read_some.html" title="windows::basic_stream_handle::async_read_some"><span class="bold"><strong>async_read_some</strong></span></a> </p> </td> <td> <p> Start an asynchronous read. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/async_write_some.html" title="windows::basic_stream_handle::async_write_some"><span class="bold"><strong>async_write_some</strong></span></a> </p> </td> <td> <p> Start an asynchronous write. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle"><span class="bold"><strong>basic_stream_handle</strong></span></a> <span class="silver">[constructor]</span> </p> </td> <td> <p> Construct a stream handle without opening it. <br> <span class="silver"> —</span><br> Construct a stream handle on an existing native handle. <br> <span class="silver"> —</span><br> Move-construct a stream handle from another. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/cancel.html" title="windows::basic_stream_handle::cancel"><span class="bold"><strong>cancel</strong></span></a> </p> </td> <td> <p> Cancel all asynchronous operations associated with the handle. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/close.html" title="windows::basic_stream_handle::close"><span class="bold"><strong>close</strong></span></a> </p> </td> <td> <p> Close the handle. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/get_executor.html" title="windows::basic_stream_handle::get_executor"><span class="bold"><strong>get_executor</strong></span></a> </p> </td> <td> <p> Get the executor associated with the object. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/is_open.html" title="windows::basic_stream_handle::is_open"><span class="bold"><strong>is_open</strong></span></a> </p> </td> <td> <p> Determine whether the handle is open. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/lowest_layer.html" title="windows::basic_stream_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a> </p> </td> <td> <p> Get a reference to the lowest layer. <br> <span class="silver"> —</span><br> Get a const reference to the lowest layer. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/native_handle.html" title="windows::basic_stream_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a> </p> </td> <td> <p> Get the native handle representation. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/operator_eq_.html" title="windows::basic_stream_handle::operator="><span class="bold"><strong>operator=</strong></span></a> </p> </td> <td> <p> Move-assign a stream handle from another. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/read_some.html" title="windows::basic_stream_handle::read_some"><span class="bold"><strong>read_some</strong></span></a> </p> </td> <td> <p> Read some data from the handle. </p> </td> </tr> <tr> <td> <p> <a class="link" href="windows__basic_stream_handle/write_some.html" title="windows::basic_stream_handle::write_some"><span class="bold"><strong>write_some</strong></span></a> </p> </td> <td> <p> Write some data to the handle. </p> </td> </tr> </tbody> </table></div> <p> The <a class="link" href="windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput">windows::basic_stream_handle</code></a> class provides asynchronous and blocking stream-oriented handle functionality. </p> <h5> <a name="boost_asio.reference.windows__basic_stream_handle.h2"></a> <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.thread_safety"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.thread_safety">Thread Safety</a> </h5> <p> <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. </p> <p> <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. </p> <h5> <a name="boost_asio.reference.windows__basic_stream_handle.h3"></a> <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.requirements"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.requirements">Requirements</a> </h5> <p> <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_stream_handle.hpp</code> </p> <p> <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> </p> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> <td align="right"><div class="copyright-footer">Copyright © 2003-2021 Christopher M. Kohlhoff<p> Distributed under the Boost Software License, Version 1.0. (See accompanying 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>) </p> </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="windows__basic_random_access_handle__rebind_executor/other.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="windows__basic_stream_handle/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html>