[DEV] add v1.76.0

This commit is contained in:
2021-10-05 21:37:46 +02:00
parent a97e9ae7d4
commit d0115b733d
45133 changed files with 4744437 additions and 1026325 deletions

View File

@@ -0,0 +1,58 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::assign</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="next" href="assign/overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)">
</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_stream_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="assign/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.assign"></a><a class="link" href="assign.html" title="windows::basic_stream_handle::assign">windows::basic_stream_handle::assign</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.assign"></a>
Assign
an existing native handle to the handle.
</p>
<pre class="programlisting">void <a class="link" href="assign/overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)">assign</a>(
const native_handle_type &amp; handle);
<span class="emphasis"><em>» <a class="link" href="assign/overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="assign/overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)">assign</a>(
const native_handle_type &amp; handle,
boost::system::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="assign/overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)">more...</a></em></span>
</pre>
</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_stream_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="assign/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::assign (1 of 2 overloads)</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="../assign.html" title="windows::basic_stream_handle::assign">
<link rel="prev" href="../assign.html" title="windows::basic_stream_handle::assign">
<link rel="next" href="overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)">
</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="../assign.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.assign.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)">windows::basic_stream_handle::assign
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
Assign an existing native handle to the handle.
</p>
<pre class="programlisting">void assign(
const native_handle_type &amp; handle);
</pre>
</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="../assign.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,55 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::assign (2 of 2 overloads)</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="../assign.html" title="windows::basic_stream_handle::assign">
<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)">
<link rel="next" href="../async_read_some.html" title="windows::basic_stream_handle::async_read_some">
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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="../async_read_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.assign.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)">windows::basic_stream_handle::assign
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
Assign an existing native handle to the handle.
</p>
<pre class="programlisting">void assign(
const native_handle_type &amp; handle,
boost::system::error_code &amp; ec);
</pre>
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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="../async_read_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,120 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::async_read_some</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="assign/overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)">
<link rel="next" href="async_write_some.html" title="windows::basic_stream_handle::async_write_some">
</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="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.async_read_some"></a><a class="link" href="async_read_some.html" title="windows::basic_stream_handle::async_read_some">windows::basic_stream_handle::async_read_some</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.async_read_some"></a>
Start
an asynchronous read.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
typename <a class="link" href="../ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_read_some(
const MutableBufferSequence &amp; buffers,
ReadHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function is used to asynchronously read data from the stream handle.
The function call always returns immediately.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.parameters"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.windows__basic_stream_handle.async_read_some.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
One or more buffers into which the data will be read. Although the
buffers object may be copied as necessary, ownership of the underlying
memory blocks is retained by the caller, which must guarantee that
they remain valid until the handler is called.
</p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the read operation completes. Copies
will be made of the handler as required. The function signature of
the handler must be:
</p>
<pre class="programlisting">void handler(
const boost::system::error_code&amp; error, // Result of operation.
std::size_t bytes_transferred // Number of bytes read.
);
</pre>
<p>
Regardless of whether the asynchronous operation completes immediately
or not, the handler will not be invoked from within this function.
On immediate completion, invocation of the handler will be performed
in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>.
</p>
</dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.remarks"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.windows__basic_stream_handle.async_read_some.remarks">Remarks</a>
</h6>
<p>
The read operation may not read all of the requested number of bytes. Consider
using the <a class="link" href="../async_read.html" title="async_read"><code class="computeroutput">async_read</code></a>
function if you need to ensure that the requested amount of data is read
before the asynchronous operation completes.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.h2"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.example"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.windows__basic_stream_handle.async_read_some.example">Example</a>
</h6>
<p>
To read into a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
function as follows:
</p>
<pre class="programlisting">handle.async_read_some(boost::asio::buffer(data, size), handler);
</pre>
<p>
See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
documentation for information on reading into multiple buffers in one go,
and how to use it with arrays, boost::array or std::vector.
</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="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,120 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::async_write_some</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="async_read_some.html" title="windows::basic_stream_handle::async_read_some">
<link rel="next" href="basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle">
</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="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="basic_stream_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.async_write_some"></a><a class="link" href="async_write_some.html" title="windows::basic_stream_handle::async_write_some">windows::basic_stream_handle::async_write_some</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.async_write_some"></a>
Start
an asynchronous write.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>,
typename <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a> = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_write_some(
const ConstBufferSequence &amp; buffers,
WriteHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function is used to asynchronously write data to the stream handle.
The function call always returns immediately.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.windows__basic_stream_handle.async_write_some.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
One or more data buffers to be written to the handle. Although the
buffers object may be copied as necessary, ownership of the underlying
memory blocks is retained by the caller, which must guarantee that
they remain valid until the handler is called.
</p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the write operation completes. Copies
will be made of the handler as required. The function signature of
the handler must be:
</p>
<pre class="programlisting">void handler(
const boost::system::error_code&amp; error, // Result of operation.
std::size_t bytes_transferred // Number of bytes written.
);
</pre>
<p>
Regardless of whether the asynchronous operation completes immediately
or not, the handler will not be invoked from within this function.
On immediate completion, invocation of the handler will be performed
in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>.
</p>
</dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.remarks"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.windows__basic_stream_handle.async_write_some.remarks">Remarks</a>
</h6>
<p>
The write operation may not transmit all of the data to the peer. Consider
using the <a class="link" href="../async_write.html" title="async_write"><code class="computeroutput">async_write</code></a>
function if you need to ensure that all data is written before the asynchronous
operation completes.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.h2"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.example"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.windows__basic_stream_handle.async_write_some.example">Example</a>
</h6>
<p>
To write a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
function as follows:
</p>
<pre class="programlisting">handle.async_write_some(boost::asio::buffer(data, size), handler);
</pre>
<p>
See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
documentation for information on writing multiple buffers in one go, and
how to use it with arrays, boost::array or std::vector.
</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="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="basic_stream_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,83 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="async_write_some.html" title="windows::basic_stream_handle::async_write_some">
<link rel="next" href="basic_stream_handle/overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 5 overloads)">
</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="async_write_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="basic_stream_handle/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle"></a><a class="link" href="basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle">windows::basic_stream_handle::basic_stream_handle</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.basic_stream_handle"></a>
Construct
a stream handle without opening it.
</p>
<pre class="programlisting">explicit <a class="link" href="basic_stream_handle/overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 5 overloads)">basic_stream_handle</a>(
const executor_type &amp; ex);
<span class="emphasis"><em>» <a class="link" href="basic_stream_handle/overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 5 overloads)">more...</a></em></span>
template&lt;
typename ExecutionContext&gt;
explicit <a class="link" href="basic_stream_handle/overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 5 overloads)">basic_stream_handle</a>(
ExecutionContext &amp; context,
typename constraint&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value, defaulted_constraint &gt;::type = defaulted_constraint());
<span class="emphasis"><em>» <a class="link" href="basic_stream_handle/overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 5 overloads)">more...</a></em></span>
</pre>
<p>
Construct a stream handle on an existing native handle.
</p>
<pre class="programlisting"><a class="link" href="basic_stream_handle/overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 5 overloads)">basic_stream_handle</a>(
const executor_type &amp; ex,
const native_handle_type &amp; handle);
<span class="emphasis"><em>» <a class="link" href="basic_stream_handle/overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 5 overloads)">more...</a></em></span>
template&lt;
typename ExecutionContext&gt;
<a class="link" href="basic_stream_handle/overload4.html" title="windows::basic_stream_handle::basic_stream_handle (4 of 5 overloads)">basic_stream_handle</a>(
ExecutionContext &amp; context,
const native_handle_type &amp; handle,
typename constraint&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type = 0);
<span class="emphasis"><em>» <a class="link" href="basic_stream_handle/overload4.html" title="windows::basic_stream_handle::basic_stream_handle (4 of 5 overloads)">more...</a></em></span>
</pre>
<p>
Move-construct a stream handle from another.
</p>
<pre class="programlisting"><a class="link" href="basic_stream_handle/overload5.html" title="windows::basic_stream_handle::basic_stream_handle (5 of 5 overloads)">basic_stream_handle</a>(
basic_stream_handle &amp;&amp; other);
<span class="emphasis"><em>» <a class="link" href="basic_stream_handle/overload5.html" title="windows::basic_stream_handle::basic_stream_handle (5 of 5 overloads)">more...</a></em></span>
</pre>
</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="async_write_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="basic_stream_handle/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,69 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::basic_stream_handle (1 of 5 overloads)</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="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle">
<link rel="prev" href="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle">
<link rel="next" href="overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 5 overloads)">
</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="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 5 overloads)">windows::basic_stream_handle::basic_stream_handle
(1 of 5 overloads)</a>
</h5></div></div></div>
<p>
Construct a stream handle without opening it.
</p>
<pre class="programlisting">basic_stream_handle(
const executor_type &amp; ex);
</pre>
<p>
This constructor creates a stream handle without opening it.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload1.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">ex</span></dt>
<dd><p>
The I/O executor that the stream handle will use, by default, to
dispatch handlers for any asynchronous operations performed on
the stream handle.
</p></dd>
</dl>
</div>
</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="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,74 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::basic_stream_handle (2 of 5 overloads)</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="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle">
<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 5 overloads)">
<link rel="next" href="overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 5 overloads)">
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 5 overloads)">windows::basic_stream_handle::basic_stream_handle
(2 of 5 overloads)</a>
</h5></div></div></div>
<p>
Construct a stream handle without opening it.
</p>
<pre class="programlisting">template&lt;
typename ExecutionContext&gt;
basic_stream_handle(
ExecutionContext &amp; context,
typename constraint&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value, defaulted_constraint &gt;::type = defaulted_constraint());
</pre>
<p>
This constructor creates a stream handle without opening it. The handle
needs to be opened or assigned before data can be sent or received on
it.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">context</span></dt>
<dd><p>
An execution context which provides the I/O executor that the stream
handle will use, by default, to dispatch handlers for any asynchronous
operations performed on the stream handle.
</p></dd>
</dl>
</div>
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,88 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::basic_stream_handle (3 of 5 overloads)</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="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle">
<link rel="prev" href="overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 5 overloads)">
<link rel="next" href="overload4.html" title="windows::basic_stream_handle::basic_stream_handle (4 of 5 overloads)">
</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="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="overload4.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3"></a><a class="link" href="overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 5 overloads)">windows::basic_stream_handle::basic_stream_handle
(3 of 5 overloads)</a>
</h5></div></div></div>
<p>
Construct a stream handle on an existing native handle.
</p>
<pre class="programlisting">basic_stream_handle(
const executor_type &amp; ex,
const native_handle_type &amp; handle);
</pre>
<p>
This constructor creates a stream handle object to hold an existing native
handle.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">ex</span></dt>
<dd><p>
The I/O executor that the stream handle will use, by default, to
dispatch handlers for any asynchronous operations performed on
the stream handle.
</p></dd>
<dt><span class="term">handle</span></dt>
<dd><p>
The new underlying handle implementation.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.exceptions"></a></span><a class="link" href="overload3.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
</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="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="overload4.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,91 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::basic_stream_handle (4 of 5 overloads)</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="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle">
<link rel="prev" href="overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 5 overloads)">
<link rel="next" href="overload5.html" title="windows::basic_stream_handle::basic_stream_handle (5 of 5 overloads)">
</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="overload3.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="overload5.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload4"></a><a class="link" href="overload4.html" title="windows::basic_stream_handle::basic_stream_handle (4 of 5 overloads)">windows::basic_stream_handle::basic_stream_handle
(4 of 5 overloads)</a>
</h5></div></div></div>
<p>
Construct a stream handle on an existing native handle.
</p>
<pre class="programlisting">template&lt;
typename ExecutionContext&gt;
basic_stream_handle(
ExecutionContext &amp; context,
const native_handle_type &amp; handle,
typename constraint&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type = 0);
</pre>
<p>
This constructor creates a stream handle object to hold an existing native
handle.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload4.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload4.parameters"></a></span><a class="link" href="overload4.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload4.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">context</span></dt>
<dd><p>
An execution context which provides the I/O executor that the stream
handle will use, by default, to dispatch handlers for any asynchronous
operations performed on the stream handle.
</p></dd>
<dt><span class="term">handle</span></dt>
<dd><p>
The new underlying handle implementation.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload4.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload4.exceptions"></a></span><a class="link" href="overload4.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload4.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
</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="overload3.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="overload5.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,76 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::basic_stream_handle (5 of 5 overloads)</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="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle">
<link rel="prev" href="overload4.html" title="windows::basic_stream_handle::basic_stream_handle (4 of 5 overloads)">
<link rel="next" href="../cancel.html" title="windows::basic_stream_handle::cancel">
</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="overload4.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="../cancel.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload5"></a><a class="link" href="overload5.html" title="windows::basic_stream_handle::basic_stream_handle (5 of 5 overloads)">windows::basic_stream_handle::basic_stream_handle
(5 of 5 overloads)</a>
</h5></div></div></div>
<p>
Move-construct a stream handle from another.
</p>
<pre class="programlisting">basic_stream_handle(
basic_stream_handle &amp;&amp; other);
</pre>
<p>
This constructor moves a stream handle from one object to another.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload5.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload5.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">other</span></dt>
<dd><p>
The other stream handle object from which the move will occur.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload5.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload5.remarks"></a></span><a class="link" href="overload5.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload5.remarks">Remarks</a>
</h6>
<p>
Following the move, the moved-from object is in the same state as if
constructed using the <code class="computeroutput">basic_stream_handle(const executor_type&amp;)</code>
constructor.
</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="overload4.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.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="../cancel.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,56 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::cancel</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="basic_stream_handle/overload5.html" title="windows::basic_stream_handle::basic_stream_handle (5 of 5 overloads)">
<link rel="next" href="cancel/overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)">
</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="basic_stream_handle/overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.cancel"></a><a class="link" href="cancel.html" title="windows::basic_stream_handle::cancel">windows::basic_stream_handle::cancel</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.cancel"></a>
Cancel
all asynchronous operations associated with the handle.
</p>
<pre class="programlisting">void <a class="link" href="cancel/overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)">cancel</a>();
<span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="cancel/overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)">cancel</a>(
boost::system::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)">more...</a></em></span>
</pre>
</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="basic_stream_handle/overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,71 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::cancel (1 of 2 overloads)</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="../cancel.html" title="windows::basic_stream_handle::cancel">
<link rel="prev" href="../cancel.html" title="windows::basic_stream_handle::cancel">
<link rel="next" href="overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)">
</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="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)">windows::basic_stream_handle::cancel
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
Cancel all asynchronous operations associated with the handle.
</p>
<pre class="programlisting">void cancel();
</pre>
<p>
This function causes all outstanding asynchronous read or write operations
to finish immediately, and the handlers for cancelled operations will
be passed the <code class="computeroutput">boost::asio::error::operation_aborted</code> error.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload1.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.cancel.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
</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="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,72 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::cancel (2 of 2 overloads)</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="../cancel.html" title="windows::basic_stream_handle::cancel">
<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)">
<link rel="next" href="../close.html" title="windows::basic_stream_handle::close">
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="../close.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)">windows::basic_stream_handle::cancel
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
Cancel all asynchronous operations associated with the handle.
</p>
<pre class="programlisting">void cancel(
boost::system::error_code &amp; ec);
</pre>
<p>
This function causes all outstanding asynchronous read or write operations
to finish immediately, and the handlers for cancelled operations will
be passed the <code class="computeroutput">boost::asio::error::operation_aborted</code> error.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload2.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.cancel.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="../close.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,56 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::close</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="cancel/overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)">
<link rel="next" href="close/overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)">
</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="cancel/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="close/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.close"></a><a class="link" href="close.html" title="windows::basic_stream_handle::close">windows::basic_stream_handle::close</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.close"></a>
Close
the handle.
</p>
<pre class="programlisting">void <a class="link" href="close/overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)">close</a>();
<span class="emphasis"><em>» <a class="link" href="close/overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="close/overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)">close</a>(
boost::system::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="close/overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)">more...</a></em></span>
</pre>
</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="cancel/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="close/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,71 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::close (1 of 2 overloads)</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="../close.html" title="windows::basic_stream_handle::close">
<link rel="prev" href="../close.html" title="windows::basic_stream_handle::close">
<link rel="next" href="overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)">
</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="../close.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.close.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)">windows::basic_stream_handle::close
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
Close the handle.
</p>
<pre class="programlisting">void close();
</pre>
<p>
This function is used to close the handle. Any asynchronous read or write
operations will be cancelled immediately, and will complete with the
<code class="computeroutput">boost::asio::error::operation_aborted</code> error.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.close.overload1.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.close.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.close.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
</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="../close.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,72 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::close (2 of 2 overloads)</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="../close.html" title="windows::basic_stream_handle::close">
<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)">
<link rel="next" href="../executor_type.html" title="windows::basic_stream_handle::executor_type">
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="../executor_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.close.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)">windows::basic_stream_handle::close
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
Close the handle.
</p>
<pre class="programlisting">void close(
boost::system::error_code &amp; ec);
</pre>
<p>
This function is used to close the handle. Any asynchronous read or write
operations will be cancelled immediately, and will complete with the
<code class="computeroutput">boost::asio::error::operation_aborted</code> error.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.close.overload2.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.close.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.close.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="../executor_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,61 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::executor_type</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="close/overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)">
<link rel="next" href="get_executor.html" title="windows::basic_stream_handle::get_executor">
</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="close/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="get_executor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.executor_type"></a><a class="link" href="executor_type.html" title="windows::basic_stream_handle::executor_type">windows::basic_stream_handle::executor_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.executor_type"></a>
The
type of the executor associated with the object.
</p>
<pre class="programlisting">typedef Executor executor_type;
</pre>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.executor_type.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.executor_type.requirements"></a></span><a class="link" href="executor_type.html#boost_asio.reference.windows__basic_stream_handle.executor_type.requirements">Requirements</a>
</h6>
<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="close/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="get_executor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::get_executor</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="executor_type.html" title="windows::basic_stream_handle::executor_type">
<link rel="next" href="is_open.html" title="windows::basic_stream_handle::is_open">
</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="executor_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="is_open.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.get_executor"></a><a class="link" href="get_executor.html" title="windows::basic_stream_handle::get_executor">windows::basic_stream_handle::get_executor</a>
</h4></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.get_executor"></a>
Get
the executor associated with the object.
</p>
<pre class="programlisting">executor_type get_executor();
</pre>
</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="executor_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="is_open.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::is_open</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="get_executor.html" title="windows::basic_stream_handle::get_executor">
<link rel="next" href="lowest_layer.html" title="windows::basic_stream_handle::lowest_layer">
</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="get_executor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="lowest_layer.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.is_open"></a><a class="link" href="is_open.html" title="windows::basic_stream_handle::is_open">windows::basic_stream_handle::is_open</a>
</h4></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.is_open"></a>
Determine
whether the handle is open.
</p>
<pre class="programlisting">bool is_open() const;
</pre>
</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="get_executor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="lowest_layer.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,58 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::lowest_layer</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="is_open.html" title="windows::basic_stream_handle::is_open">
<link rel="next" href="lowest_layer/overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)">
</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="is_open.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="lowest_layer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer"></a><a class="link" href="lowest_layer.html" title="windows::basic_stream_handle::lowest_layer">windows::basic_stream_handle::lowest_layer</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.lowest_layer"></a>
Get
a reference to the lowest layer.
</p>
<pre class="programlisting">lowest_layer_type &amp; <a class="link" href="lowest_layer/overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)">lowest_layer</a>();
<span class="emphasis"><em>» <a class="link" href="lowest_layer/overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)">more...</a></em></span>
</pre>
<p>
Get a const reference to the lowest layer.
</p>
<pre class="programlisting">const lowest_layer_type &amp; <a class="link" href="lowest_layer/overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)">lowest_layer</a>() const;
<span class="emphasis"><em>» <a class="link" href="lowest_layer/overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)">more...</a></em></span>
</pre>
</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="is_open.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="lowest_layer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,67 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::lowest_layer (1 of 2 overloads)</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="../lowest_layer.html" title="windows::basic_stream_handle::lowest_layer">
<link rel="prev" href="../lowest_layer.html" title="windows::basic_stream_handle::lowest_layer">
<link rel="next" href="overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)">
</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="../lowest_layer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)">windows::basic_stream_handle::lowest_layer
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
Get a reference to the lowest layer.
</p>
<pre class="programlisting">lowest_layer_type &amp; lowest_layer();
</pre>
<p>
This function returns a reference to the lowest layer in a stack of layers.
Since an overlapped_handle cannot contain any further layers, it simply
returns a reference to itself.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload1.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload1.return_value">Return
Value</a>
</h6>
<p>
A reference to the lowest layer in the stack of layers. Ownership is
not transferred to the caller.
</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="../lowest_layer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,67 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::lowest_layer (2 of 2 overloads)</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="../lowest_layer.html" title="windows::basic_stream_handle::lowest_layer">
<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)">
<link rel="next" href="../lowest_layer_type.html" title="windows::basic_stream_handle::lowest_layer_type">
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="../lowest_layer_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)">windows::basic_stream_handle::lowest_layer
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
Get a const reference to the lowest layer.
</p>
<pre class="programlisting">const lowest_layer_type &amp; lowest_layer() const;
</pre>
<p>
This function returns a const reference to the lowest layer in a stack
of layers. Since an overlapped_handle cannot contain any further layers,
it simply returns a reference to itself.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload2.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload2.return_value">Return
Value</a>
</h6>
<p>
A const reference to the lowest layer in the stack of layers. Ownership
is not transferred to the caller.
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="../lowest_layer_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,323 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::lowest_layer_type</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="lowest_layer/overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)">
<link rel="next" href="native_handle.html" title="windows::basic_stream_handle::native_handle">
</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="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="native_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="windows::basic_stream_handle::lowest_layer_type">windows::basic_stream_handle::lowest_layer_type</a>
</h4></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.lowest_layer_type"></a>
An
overlapped_handle is always the lowest layer.
</p>
<pre class="programlisting">typedef basic_overlapped_handle lowest_layer_type;
</pre>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.types">Types</a>
</h6>
<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_overlapped_handle__rebind_executor.html" title="windows::basic_overlapped_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_overlapped_handle/executor_type.html" title="windows::basic_overlapped_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_overlapped_handle/lowest_layer_type.html" title="windows::basic_overlapped_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_overlapped_handle/native_handle_type.html" title="windows::basic_overlapped_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>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.member_functions">Member
Functions</a>
</h6>
<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_overlapped_handle/assign.html" title="windows::basic_overlapped_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_overlapped_handle/basic_overlapped_handle.html" title="windows::basic_overlapped_handle::basic_overlapped_handle"><span class="bold"><strong>basic_overlapped_handle</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Construct an overlapped handle without opening it. <br> <span class="silver"></span><br>
Construct an overlapped handle on an existing native handle.
<br> <span class="silver"></span><br> Move-construct an overlapped handle from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="../windows__basic_overlapped_handle/cancel.html" title="windows::basic_overlapped_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_overlapped_handle/close.html" title="windows::basic_overlapped_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_overlapped_handle/get_executor.html" title="windows::basic_overlapped_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_overlapped_handle/is_open.html" title="windows::basic_overlapped_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_overlapped_handle/lowest_layer.html" title="windows::basic_overlapped_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_overlapped_handle/native_handle.html" title="windows::basic_overlapped_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_overlapped_handle/operator_eq_.html" title="windows::basic_overlapped_handle::operator="><span class="bold"><strong>operator=</strong></span></a>
</p>
</td>
<td>
<p>
Move-assign an overlapped handle from another.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h2"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.protected_member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.protected_member_functions">Protected
Member Functions</a>
</h6>
<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_overlapped_handle/_basic_overlapped_handle.html" title="windows::basic_overlapped_handle::~basic_overlapped_handle"><span class="bold"><strong>~basic_overlapped_handle</strong></span></a> <span class="silver">[destructor]</span>
</p>
</td>
<td>
<p>
Protected destructor to prevent deletion through this type.
</p>
</td>
</tr></tbody>
</table></div>
<p>
The <a class="link" href="../windows__overlapped_handle.html" title="windows::overlapped_handle"><code class="computeroutput">windows::overlapped_handle</code></a>
class provides the ability to wrap a Windows handle. The underlying object
referred to by the handle must support overlapped I/O.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h3"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.thread_safety">Thread
Safety</a>
</h6>
<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>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h4"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.requirements">Requirements</a>
</h6>
<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="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="native_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,59 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::native_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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="lowest_layer_type.html" title="windows::basic_stream_handle::lowest_layer_type">
<link rel="next" href="native_handle_type.html" title="windows::basic_stream_handle::native_handle_type">
</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="lowest_layer_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="native_handle_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.native_handle"></a><a class="link" href="native_handle.html" title="windows::basic_stream_handle::native_handle">windows::basic_stream_handle::native_handle</a>
</h4></div></div></div>
<p>
<span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
</p>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.native_handle"></a>
Get
the native handle representation.
</p>
<pre class="programlisting">native_handle_type native_handle();
</pre>
<p>
This function may be used to obtain the underlying representation of the
handle. This is intended to allow access to native handle functionality
that is not otherwise provided.
</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="lowest_layer_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="native_handle_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,61 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::native_handle_type</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="native_handle.html" title="windows::basic_stream_handle::native_handle">
<link rel="next" href="operator_eq_.html" title="windows::basic_stream_handle::operator=">
</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="native_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="operator_eq_.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.native_handle_type"></a><a class="link" href="native_handle_type.html" title="windows::basic_stream_handle::native_handle_type">windows::basic_stream_handle::native_handle_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.native_handle_type"></a>
The
native representation of a handle.
</p>
<pre class="programlisting">typedef implementation_defined native_handle_type;
</pre>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.native_handle_type.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.native_handle_type.requirements"></a></span><a class="link" href="native_handle_type.html#boost_asio.reference.windows__basic_stream_handle.native_handle_type.requirements">Requirements</a>
</h6>
<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="native_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="operator_eq_.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,76 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::operator=</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="native_handle_type.html" title="windows::basic_stream_handle::native_handle_type">
<link rel="next" href="read_some.html" title="windows::basic_stream_handle::read_some">
</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="native_handle_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="read_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_"></a><a class="link" href="operator_eq_.html" title="windows::basic_stream_handle::operator=">windows::basic_stream_handle::operator=</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.operator_eq_"></a>
Move-assign
a stream handle from another.
</p>
<pre class="programlisting">basic_stream_handle &amp; operator=(
basic_stream_handle &amp;&amp; other);
</pre>
<p>
This assignment operator moves a stream handle from one object to another.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_.parameters"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.windows__basic_stream_handle.operator_eq_.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">other</span></dt>
<dd><p>
The other stream handle object from which the move will occur.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_.remarks"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.windows__basic_stream_handle.operator_eq_.remarks">Remarks</a>
</h6>
<p>
Following the move, the moved-from object is in the same state as if constructed
using the <code class="computeroutput">basic_stream_handle(const executor_type&amp;)</code> constructor.
</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="native_handle_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="read_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::read_some</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="operator_eq_.html" title="windows::basic_stream_handle::operator=">
<link rel="next" href="read_some/overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)">
</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="operator_eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="read_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.read_some"></a><a class="link" href="read_some.html" title="windows::basic_stream_handle::read_some">windows::basic_stream_handle::read_some</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.read_some"></a>
Read
some data from the handle.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t <a class="link" href="read_some/overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)">read_some</a>(
const MutableBufferSequence &amp; buffers);
<span class="emphasis"><em>» <a class="link" href="read_some/overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t <a class="link" href="read_some/overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)">read_some</a>(
const MutableBufferSequence &amp; buffers,
boost::system::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="read_some/overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)">more...</a></em></span>
</pre>
</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="operator_eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="read_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,118 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::read_some (1 of 2 overloads)</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="../read_some.html" title="windows::basic_stream_handle::read_some">
<link rel="prev" href="../read_some.html" title="windows::basic_stream_handle::read_some">
<link rel="next" href="overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)">
</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="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)">windows::basic_stream_handle::read_some
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Read some data from the handle.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t read_some(
const MutableBufferSequence &amp; buffers);
</pre>
<p>
This function is used to read data from the stream handle. The function
call will block until one or more bytes of data has been read successfully,
or until an error occurs.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
One or more buffers into which the data will be read.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.return_value">Return
Value</a>
</h6>
<p>
The number of bytes read.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h2"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code>
indicates that the connection was closed by the peer.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h3"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.remarks">Remarks</a>
</h6>
<p>
The read_some operation may not read all of the requested number of bytes.
Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput">read</code></a>
function if you need to ensure that the requested amount of data is read
before the blocking operation completes.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h4"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.example">Example</a>
</h6>
<p>
To read into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
function as follows:
</p>
<pre class="programlisting">handle.read_some(boost::asio::buffer(data, size));
</pre>
<p>
See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
documentation for information on reading into multiple buffers in one
go, and how to use it with arrays, boost::array or std::vector.
</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="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,94 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::read_some (2 of 2 overloads)</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="../read_some.html" title="windows::basic_stream_handle::read_some">
<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)">
<link rel="next" href="../write_some.html" title="windows::basic_stream_handle::write_some">
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="../write_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)">windows::basic_stream_handle::read_some
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Read some data from the handle.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t read_some(
const MutableBufferSequence &amp; buffers,
boost::system::error_code &amp; ec);
</pre>
<p>
This function is used to read data from the stream handle. The function
call will block until one or more bytes of data has been read successfully,
or until an error occurs.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
One or more buffers into which the data will be read.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of bytes read. Returns 0 if an error occurred.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.h2"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload2.remarks">Remarks</a>
</h6>
<p>
The read_some operation may not read all of the requested number of bytes.
Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput">read</code></a>
function if you need to ensure that the requested amount of data is read
before the blocking operation completes.
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="../write_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::write_some</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="../windows__basic_stream_handle.html" title="windows::basic_stream_handle">
<link rel="prev" href="read_some/overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)">
<link rel="next" href="write_some/overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)">
</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="read_some/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="write_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.write_some"></a><a class="link" href="write_some.html" title="windows::basic_stream_handle::write_some">windows::basic_stream_handle::write_some</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.windows__basic_stream_handle.write_some"></a>
Write
some data to the handle.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
std::size_t <a class="link" href="write_some/overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)">write_some</a>(
const ConstBufferSequence &amp; buffers);
<span class="emphasis"><em>» <a class="link" href="write_some/overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
std::size_t <a class="link" href="write_some/overload2.html" title="windows::basic_stream_handle::write_some (2 of 2 overloads)">write_some</a>(
const ConstBufferSequence &amp; buffers,
boost::system::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="write_some/overload2.html" title="windows::basic_stream_handle::write_some (2 of 2 overloads)">more...</a></em></span>
</pre>
</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="read_some/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.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="write_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,118 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::write_some (1 of 2 overloads)</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="../write_some.html" title="windows::basic_stream_handle::write_some">
<link rel="prev" href="../write_some.html" title="windows::basic_stream_handle::write_some">
<link rel="next" href="overload2.html" title="windows::basic_stream_handle::write_some (2 of 2 overloads)">
</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="../write_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)">windows::basic_stream_handle::write_some
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Write some data to the handle.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
std::size_t write_some(
const ConstBufferSequence &amp; buffers);
</pre>
<p>
This function is used to write data to the stream handle. The function
call will block until one or more bytes of the data has been written
successfully, or until an error occurs.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
One or more data buffers to be written to the handle.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.return_value">Return
Value</a>
</h6>
<p>
The number of bytes written.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h2"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code>
indicates that the connection was closed by the peer.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h3"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.remarks">Remarks</a>
</h6>
<p>
The write_some operation may not transmit all of the data to the peer.
Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a>
function if you need to ensure that all data is written before the blocking
operation completes.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h4"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.example">Example</a>
</h6>
<p>
To write a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
function as follows:
</p>
<pre class="programlisting">handle.write_some(boost::asio::buffer(data, size));
</pre>
<p>
See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
documentation for information on writing multiple buffers in one go,
and how to use it with arrays, boost::array or std::vector.
</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="../write_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,94 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>windows::basic_stream_handle::write_some (2 of 2 overloads)</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="../write_some.html" title="windows::basic_stream_handle::write_some">
<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)">
<link rel="next" href="../../windows__basic_stream_handle__rebind_executor.html" title="windows::basic_stream_handle::rebind_executor">
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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__rebind_executor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::write_some (2 of 2 overloads)">windows::basic_stream_handle::write_some
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Write some data to the handle.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
std::size_t write_some(
const ConstBufferSequence &amp; buffers,
boost::system::error_code &amp; ec);
</pre>
<p>
This function is used to write data to the stream handle. The function
call will block until one or more bytes of the data has been written
successfully, or until an error occurs.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.h0"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
One or more data buffers to be written to the handle.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.h1"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of bytes written. Returns 0 if an error occurred.
</p>
<h6>
<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.h2"></a>
<span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload2.remarks">Remarks</a>
</h6>
<p>
The write_some operation may not transmit all of the data to the peer.
Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a>
function if you need to ensure that all data is written before the blocking
operation completes.
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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__rebind_executor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>