diff options
Diffstat (limited to 'doc/html/boost_asio/reference/windows__basic_random_access_handle')
34 files changed, 2789 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/assign.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/assign.html new file mode 100644 index 0000000000..e58104e141 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/assign.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="../windows__basic_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="next" href="assign/overload1.html" title="windows::basic_random_access_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_random_access_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_random_access_handle.assign"></a><a class="link" href="assign.html" title="windows::basic_random_access_handle::assign">windows::basic_random_access_handle::assign</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_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_random_access_handle::assign (1 of 2 overloads)">assign</a>( + const native_handle_type & handle); + <span class="emphasis"><em>» <a class="link" href="assign/overload1.html" title="windows::basic_random_access_handle::assign (1 of 2 overloads)">more...</a></em></span> + +void <a class="link" href="assign/overload2.html" title="windows::basic_random_access_handle::assign (2 of 2 overloads)">assign</a>( + const native_handle_type & handle, + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="assign/overload2.html" title="windows::basic_random_access_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-2019 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../windows__basic_random_access_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/assign/overload1.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/assign/overload1.html new file mode 100644 index 0000000000..3f77fd8fc4 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/assign/overload1.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle::assign"> +<link rel="prev" href="../assign.html" title="windows::basic_random_access_handle::assign"> +<link rel="next" href="overload2.html" title="windows::basic_random_access_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_random_access_handle.assign.overload1"></a><a class="link" href="overload1.html" title="windows::basic_random_access_handle::assign (1 of 2 overloads)">windows::basic_random_access_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 & 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-2019 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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/assign/overload2.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/assign/overload2.html new file mode 100644 index 0000000000..d332f402e5 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/assign/overload2.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle::assign"> +<link rel="prev" href="overload1.html" title="windows::basic_random_access_handle::assign (1 of 2 overloads)"> +<link rel="next" href="../async_read_some_at.html" title="windows::basic_random_access_handle::async_read_some_at"> +</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_at.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_random_access_handle.assign.overload2"></a><a class="link" href="overload2.html" title="windows::basic_random_access_handle::assign (2 of 2 overloads)">windows::basic_random_access_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 & handle, + boost::system::error_code & 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-2019 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_at.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/async_read_some_at.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/async_read_some_at.html new file mode 100644 index 0000000000..75b189c969 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/async_read_some_at.html @@ -0,0 +1,124 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::async_read_some_at</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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="assign/overload2.html" title="windows::basic_random_access_handle::assign (2 of 2 overloads)"> +<link rel="next" href="async_write_some_at.html" title="windows::basic_random_access_handle::async_write_some_at"> +</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_random_access_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_at.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_random_access_handle.async_read_some_at"></a><a class="link" href="async_read_some_at.html" title="windows::basic_random_access_handle::async_read_some_at">windows::basic_random_access_handle::async_read_some_at</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_handle.async_read_some_at"></a> +Start + an asynchronous read at the specified offset. + </p> +<pre class="programlisting">template< + 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.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_read_some_at( + uint64_t offset, + const MutableBufferSequence & buffers, + ReadHandler && handler); +</pre> +<p> + This function is used to asynchronously read data from the random-access + handle. The function call always returns immediately. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.async_read_some_at.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.async_read_some_at.parameters"></a></span><a class="link" href="async_read_some_at.html#boost_asio.reference.windows__basic_random_access_handle.async_read_some_at.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">offset</span></dt> +<dd><p> + The offset at which the data will be read. + </p></dd> +<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& 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_random_access_handle.async_read_some_at.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.async_read_some_at.remarks"></a></span><a class="link" href="async_read_some_at.html#boost_asio.reference.windows__basic_random_access_handle.async_read_some_at.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_at.html" title="async_read_at"><code class="computeroutput">async_read_at</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_random_access_handle.async_read_some_at.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.async_read_some_at.example"></a></span><a class="link" href="async_read_some_at.html#boost_asio.reference.windows__basic_random_access_handle.async_read_some_at.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_at(42, 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-2019 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_random_access_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_at.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/async_write_some_at.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/async_write_some_at.html new file mode 100644 index 0000000000..db3cae4595 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/async_write_some_at.html @@ -0,0 +1,124 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::async_write_some_at</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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="async_read_some_at.html" title="windows::basic_random_access_handle::async_read_some_at"> +<link rel="next" href="basic_random_access_handle.html" title="windows::basic_random_access_handle::basic_random_access_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_at.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_random_access_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_random_access_handle.async_write_some_at"></a><a class="link" href="async_write_some_at.html" title="windows::basic_random_access_handle::async_write_some_at">windows::basic_random_access_handle::async_write_some_at</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_handle.async_write_some_at"></a> +Start + an asynchronous write at the specified offset. + </p> +<pre class="programlisting">template< + 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.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_write_some_at( + uint64_t offset, + const ConstBufferSequence & buffers, + WriteHandler && handler); +</pre> +<p> + This function is used to asynchronously write data to the random-access + handle. The function call always returns immediately. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.async_write_some_at.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.async_write_some_at.parameters"></a></span><a class="link" href="async_write_some_at.html#boost_asio.reference.windows__basic_random_access_handle.async_write_some_at.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">offset</span></dt> +<dd><p> + The offset at which the data will be written. + </p></dd> +<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& 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_random_access_handle.async_write_some_at.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.async_write_some_at.remarks"></a></span><a class="link" href="async_write_some_at.html#boost_asio.reference.windows__basic_random_access_handle.async_write_some_at.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_at.html" title="async_write_at"><code class="computeroutput">async_write_at</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_random_access_handle.async_write_some_at.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.async_write_some_at.example"></a></span><a class="link" href="async_write_some_at.html#boost_asio.reference.windows__basic_random_access_handle.async_write_some_at.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_at(42, 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-2019 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_at.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_random_access_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle.html new file mode 100644 index 0000000000..f59d9d402d --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle.html @@ -0,0 +1,82 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="async_write_some_at.html" title="windows::basic_random_access_handle::async_write_some_at"> +<link rel="next" href="basic_random_access_handle/overload1.html" title="windows::basic_random_access_handle::basic_random_access_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_at.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_random_access_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_random_access_handle.basic_random_access_handle"></a><a class="link" href="basic_random_access_handle.html" title="windows::basic_random_access_handle::basic_random_access_handle">windows::basic_random_access_handle::basic_random_access_handle</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_handle.basic_random_access_handle"></a> +Construct + a random-access handle without opening it. + </p> +<pre class="programlisting">explicit <a class="link" href="basic_random_access_handle/overload1.html" title="windows::basic_random_access_handle::basic_random_access_handle (1 of 5 overloads)">basic_random_access_handle</a>( + const executor_type & ex); + <span class="emphasis"><em>» <a class="link" href="basic_random_access_handle/overload1.html" title="windows::basic_random_access_handle::basic_random_access_handle (1 of 5 overloads)">more...</a></em></span> + +template< + typename ExecutionContext> +explicit <a class="link" href="basic_random_access_handle/overload2.html" title="windows::basic_random_access_handle::basic_random_access_handle (2 of 5 overloads)">basic_random_access_handle</a>( + ExecutionContext & context, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value, basic_random_access_handle >::type * = 0); + <span class="emphasis"><em>» <a class="link" href="basic_random_access_handle/overload2.html" title="windows::basic_random_access_handle::basic_random_access_handle (2 of 5 overloads)">more...</a></em></span> +</pre> +<p> + Construct a random-access handle on an existing native handle. + </p> +<pre class="programlisting"><a class="link" href="basic_random_access_handle/overload3.html" title="windows::basic_random_access_handle::basic_random_access_handle (3 of 5 overloads)">basic_random_access_handle</a>( + const executor_type & ex, + const native_handle_type & handle); + <span class="emphasis"><em>» <a class="link" href="basic_random_access_handle/overload3.html" title="windows::basic_random_access_handle::basic_random_access_handle (3 of 5 overloads)">more...</a></em></span> + +template< + typename ExecutionContext> +<a class="link" href="basic_random_access_handle/overload4.html" title="windows::basic_random_access_handle::basic_random_access_handle (4 of 5 overloads)">basic_random_access_handle</a>( + ExecutionContext & context, + const native_handle_type & handle, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0); + <span class="emphasis"><em>» <a class="link" href="basic_random_access_handle/overload4.html" title="windows::basic_random_access_handle::basic_random_access_handle (4 of 5 overloads)">more...</a></em></span> +</pre> +<p> + Move-construct a random-access handle from another. + </p> +<pre class="programlisting"><a class="link" href="basic_random_access_handle/overload5.html" title="windows::basic_random_access_handle::basic_random_access_handle (5 of 5 overloads)">basic_random_access_handle</a>( + basic_random_access_handle && other); + <span class="emphasis"><em>» <a class="link" href="basic_random_access_handle/overload5.html" title="windows::basic_random_access_handle::basic_random_access_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-2019 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_at.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_random_access_handle/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload1.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload1.html new file mode 100644 index 0000000000..fa2b6d7650 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload1.html @@ -0,0 +1,68 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle::basic_random_access_handle"> +<link rel="prev" href="../basic_random_access_handle.html" title="windows::basic_random_access_handle::basic_random_access_handle"> +<link rel="next" href="overload2.html" title="windows::basic_random_access_handle::basic_random_access_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_random_access_handle.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_random_access_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_random_access_handle.basic_random_access_handle.overload1"></a><a class="link" href="overload1.html" title="windows::basic_random_access_handle::basic_random_access_handle (1 of 5 overloads)">windows::basic_random_access_handle::basic_random_access_handle + (1 of 5 overloads)</a> +</h5></div></div></div> +<p> + Construct a random-access handle without opening it. + </p> +<pre class="programlisting">basic_random_access_handle( + const executor_type & ex); +</pre> +<p> + This constructor creates a random-access handle without opening it. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.basic_random_access_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 random-access handle will use, by default, + to dispatch handlers for any asynchronous operations performed + on the random-access 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-2019 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_random_access_handle.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload2.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload2.html new file mode 100644 index 0000000000..453440e2fc --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload2.html @@ -0,0 +1,73 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle::basic_random_access_handle"> +<link rel="prev" href="overload1.html" title="windows::basic_random_access_handle::basic_random_access_handle (1 of 5 overloads)"> +<link rel="next" href="overload3.html" title="windows::basic_random_access_handle::basic_random_access_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_random_access_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_random_access_handle.basic_random_access_handle.overload2"></a><a class="link" href="overload2.html" title="windows::basic_random_access_handle::basic_random_access_handle (2 of 5 overloads)">windows::basic_random_access_handle::basic_random_access_handle + (2 of 5 overloads)</a> +</h5></div></div></div> +<p> + Construct a random-access handle without opening it. + </p> +<pre class="programlisting">template< + typename ExecutionContext> +basic_random_access_handle( + ExecutionContext & context, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value, basic_random_access_handle >::type * = 0); +</pre> +<p> + This constructor creates a random-access 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_random_access_handle.basic_random_access_handle.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.basic_random_access_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 random-access + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the random-access 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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload3.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload3.html new file mode 100644 index 0000000000..90ca813b2d --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload3.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle::basic_random_access_handle"> +<link rel="prev" href="overload2.html" title="windows::basic_random_access_handle::basic_random_access_handle (2 of 5 overloads)"> +<link rel="next" href="overload4.html" title="windows::basic_random_access_handle::basic_random_access_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_random_access_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_random_access_handle.basic_random_access_handle.overload3"></a><a class="link" href="overload3.html" title="windows::basic_random_access_handle::basic_random_access_handle (3 of 5 overloads)">windows::basic_random_access_handle::basic_random_access_handle + (3 of 5 overloads)</a> +</h5></div></div></div> +<p> + Construct a random-access handle on an existing native handle. + </p> +<pre class="programlisting">basic_random_access_handle( + const executor_type & ex, + const native_handle_type & handle); +</pre> +<p> + This constructor creates a random-access handle object to hold an existing + native handle. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload3.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.windows__basic_random_access_handle.basic_random_access_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 random-access handle will use, by default, + to dispatch handlers for any asynchronous operations performed + on the random-access 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_random_access_handle.basic_random_access_handle.overload3.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload3.exceptions"></a></span><a class="link" href="overload3.html#boost_asio.reference.windows__basic_random_access_handle.basic_random_access_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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload4.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload4.html new file mode 100644 index 0000000000..2ec81f3f8a --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload4.html @@ -0,0 +1,90 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle::basic_random_access_handle"> +<link rel="prev" href="overload3.html" title="windows::basic_random_access_handle::basic_random_access_handle (3 of 5 overloads)"> +<link rel="next" href="overload5.html" title="windows::basic_random_access_handle::basic_random_access_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_random_access_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_random_access_handle.basic_random_access_handle.overload4"></a><a class="link" href="overload4.html" title="windows::basic_random_access_handle::basic_random_access_handle (4 of 5 overloads)">windows::basic_random_access_handle::basic_random_access_handle + (4 of 5 overloads)</a> +</h5></div></div></div> +<p> + Construct a random-access handle on an existing native handle. + </p> +<pre class="programlisting">template< + typename ExecutionContext> +basic_random_access_handle( + ExecutionContext & context, + const native_handle_type & handle, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0); +</pre> +<p> + This constructor creates a random-access handle object to hold an existing + native handle. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload4.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload4.parameters"></a></span><a class="link" href="overload4.html#boost_asio.reference.windows__basic_random_access_handle.basic_random_access_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 random-access + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the random-access 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_random_access_handle.basic_random_access_handle.overload4.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload4.exceptions"></a></span><a class="link" href="overload4.html#boost_asio.reference.windows__basic_random_access_handle.basic_random_access_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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload5.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload5.html new file mode 100644 index 0000000000..15c593f9ce --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload5.html @@ -0,0 +1,76 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle::basic_random_access_handle"> +<link rel="prev" href="overload4.html" title="windows::basic_random_access_handle::basic_random_access_handle (4 of 5 overloads)"> +<link rel="next" href="../cancel.html" title="windows::basic_random_access_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_random_access_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_random_access_handle.basic_random_access_handle.overload5"></a><a class="link" href="overload5.html" title="windows::basic_random_access_handle::basic_random_access_handle (5 of 5 overloads)">windows::basic_random_access_handle::basic_random_access_handle + (5 of 5 overloads)</a> +</h5></div></div></div> +<p> + Move-construct a random-access handle from another. + </p> +<pre class="programlisting">basic_random_access_handle( + basic_random_access_handle && other); +</pre> +<p> + This constructor moves a random-access handle from one object to another. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload5.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.windows__basic_random_access_handle.basic_random_access_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 random-access handle object from which the move will + occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload5.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.basic_random_access_handle.overload5.remarks"></a></span><a class="link" href="overload5.html#boost_asio.reference.windows__basic_random_access_handle.basic_random_access_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_random_access_handle(const executor_type&)</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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/cancel.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/cancel.html new file mode 100644 index 0000000000..7ee806602d --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/cancel.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="basic_random_access_handle/overload5.html" title="windows::basic_random_access_handle::basic_random_access_handle (5 of 5 overloads)"> +<link rel="next" href="cancel/overload1.html" title="windows::basic_random_access_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_random_access_handle/overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_random_access_handle.cancel"></a><a class="link" href="cancel.html" title="windows::basic_random_access_handle::cancel">windows::basic_random_access_handle::cancel</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_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_random_access_handle::cancel (1 of 2 overloads)">cancel</a>(); + <span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="windows::basic_random_access_handle::cancel (1 of 2 overloads)">more...</a></em></span> + +void <a class="link" href="cancel/overload2.html" title="windows::basic_random_access_handle::cancel (2 of 2 overloads)">cancel</a>( + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="windows::basic_random_access_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-2019 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_random_access_handle/overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/cancel/overload1.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/cancel/overload1.html new file mode 100644 index 0000000000..8c19959b32 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/cancel/overload1.html @@ -0,0 +1,70 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle::cancel"> +<link rel="prev" href="../cancel.html" title="windows::basic_random_access_handle::cancel"> +<link rel="next" href="overload2.html" title="windows::basic_random_access_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_random_access_handle.cancel.overload1"></a><a class="link" href="overload1.html" title="windows::basic_random_access_handle::cancel (1 of 2 overloads)">windows::basic_random_access_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_random_access_handle.cancel.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_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-2019 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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/cancel/overload2.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/cancel/overload2.html new file mode 100644 index 0000000000..ab918f393f --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/cancel/overload2.html @@ -0,0 +1,71 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle::cancel"> +<link rel="prev" href="overload1.html" title="windows::basic_random_access_handle::cancel (1 of 2 overloads)"> +<link rel="next" href="../close.html" title="windows::basic_random_access_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_random_access_handle.cancel.overload2"></a><a class="link" href="overload2.html" title="windows::basic_random_access_handle::cancel (2 of 2 overloads)">windows::basic_random_access_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 & 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_random_access_handle.cancel.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_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-2019 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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/close.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/close.html new file mode 100644 index 0000000000..50613a5801 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/close.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="cancel/overload2.html" title="windows::basic_random_access_handle::cancel (2 of 2 overloads)"> +<link rel="next" href="close/overload1.html" title="windows::basic_random_access_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_random_access_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_random_access_handle.close"></a><a class="link" href="close.html" title="windows::basic_random_access_handle::close">windows::basic_random_access_handle::close</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_handle.close"></a> +Close + the handle. + </p> +<pre class="programlisting">void <a class="link" href="close/overload1.html" title="windows::basic_random_access_handle::close (1 of 2 overloads)">close</a>(); + <span class="emphasis"><em>» <a class="link" href="close/overload1.html" title="windows::basic_random_access_handle::close (1 of 2 overloads)">more...</a></em></span> + +void <a class="link" href="close/overload2.html" title="windows::basic_random_access_handle::close (2 of 2 overloads)">close</a>( + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="close/overload2.html" title="windows::basic_random_access_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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/close/overload1.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/close/overload1.html new file mode 100644 index 0000000000..d2d7de38a1 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/close/overload1.html @@ -0,0 +1,70 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle::close"> +<link rel="prev" href="../close.html" title="windows::basic_random_access_handle::close"> +<link rel="next" href="overload2.html" title="windows::basic_random_access_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_random_access_handle.close.overload1"></a><a class="link" href="overload1.html" title="windows::basic_random_access_handle::close (1 of 2 overloads)">windows::basic_random_access_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_random_access_handle.close.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.close.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_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-2019 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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/close/overload2.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/close/overload2.html new file mode 100644 index 0000000000..ab19c99d6b --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/close/overload2.html @@ -0,0 +1,71 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle::close"> +<link rel="prev" href="overload1.html" title="windows::basic_random_access_handle::close (1 of 2 overloads)"> +<link rel="next" href="../executor_type.html" title="windows::basic_random_access_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_random_access_handle.close.overload2"></a><a class="link" href="overload2.html" title="windows::basic_random_access_handle::close (2 of 2 overloads)">windows::basic_random_access_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 & 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_random_access_handle.close.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.close.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_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-2019 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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/executor_type.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/executor_type.html new file mode 100644 index 0000000000..713dd17aee --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/executor_type.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="close/overload2.html" title="windows::basic_random_access_handle::close (2 of 2 overloads)"> +<link rel="next" href="get_executor.html" title="windows::basic_random_access_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_random_access_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_random_access_handle.executor_type"></a><a class="link" href="executor_type.html" title="windows::basic_random_access_handle::executor_type">windows::basic_random_access_handle::executor_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_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_random_access_handle.executor_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.executor_type.requirements"></a></span><a class="link" href="executor_type.html#boost_asio.reference.windows__basic_random_access_handle.executor_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_random_access_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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/get_executor.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/get_executor.html new file mode 100644 index 0000000000..03abe9e4df --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/get_executor.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="executor_type.html" title="windows::basic_random_access_handle::executor_type"> +<link rel="next" href="impl_.html" title="windows::basic_random_access_handle::impl_"> +</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_random_access_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="impl_.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_random_access_handle.get_executor"></a><a class="link" href="get_executor.html" title="windows::basic_random_access_handle::get_executor">windows::basic_random_access_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_random_access_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-2019 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_random_access_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="impl_.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/impl_.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/impl_.html new file mode 100644 index 0000000000..40d4071954 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/impl_.html @@ -0,0 +1,51 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::impl_</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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="get_executor.html" title="windows::basic_random_access_handle::get_executor"> +<link rel="next" href="is_open.html" title="windows::basic_random_access_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="get_executor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_random_access_handle.impl_"></a><a class="link" href="impl_.html" title="windows::basic_random_access_handle::impl_">windows::basic_random_access_handle::impl_</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_random_access_handle.impl_"></a> + </p> +<pre class="programlisting">boost::asio::detail::io_object_impl< boost::asio::detail::win_iocp_handle_service, Executor > impl_; +</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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/is_open.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/is_open.html new file mode 100644 index 0000000000..9f288ffc47 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/is_open.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="impl_.html" title="windows::basic_random_access_handle::impl_"> +<link rel="next" href="lowest_layer.html" title="windows::basic_random_access_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="impl_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_random_access_handle.is_open"></a><a class="link" href="is_open.html" title="windows::basic_random_access_handle::is_open">windows::basic_random_access_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_random_access_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-2019 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="impl_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer.html new file mode 100644 index 0000000000..de8dcf2c90 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="is_open.html" title="windows::basic_random_access_handle::is_open"> +<link rel="next" href="lowest_layer/overload1.html" title="windows::basic_random_access_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_random_access_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_random_access_handle.lowest_layer"></a><a class="link" href="lowest_layer.html" title="windows::basic_random_access_handle::lowest_layer">windows::basic_random_access_handle::lowest_layer</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_handle.lowest_layer"></a> +Get + a reference to the lowest layer. + </p> +<pre class="programlisting">lowest_layer_type & <a class="link" href="lowest_layer/overload1.html" title="windows::basic_random_access_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_random_access_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 & <a class="link" href="lowest_layer/overload2.html" title="windows::basic_random_access_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_random_access_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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer/overload1.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer/overload1.html new file mode 100644 index 0000000000..d32463708c --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer/overload1.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle::lowest_layer"> +<link rel="prev" href="../lowest_layer.html" title="windows::basic_random_access_handle::lowest_layer"> +<link rel="next" href="overload2.html" title="windows::basic_random_access_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_random_access_handle.lowest_layer.overload1"></a><a class="link" href="overload1.html" title="windows::basic_random_access_handle::lowest_layer (1 of 2 overloads)">windows::basic_random_access_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 & 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_random_access_handle.lowest_layer.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_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-2019 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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer/overload2.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer/overload2.html new file mode 100644 index 0000000000..cc54a559f5 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer/overload2.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle::lowest_layer"> +<link rel="prev" href="overload1.html" title="windows::basic_random_access_handle::lowest_layer (1 of 2 overloads)"> +<link rel="next" href="../lowest_layer_type.html" title="windows::basic_random_access_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_random_access_handle.lowest_layer.overload2"></a><a class="link" href="overload2.html" title="windows::basic_random_access_handle::lowest_layer (2 of 2 overloads)">windows::basic_random_access_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 & 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_random_access_handle.lowest_layer.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_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-2019 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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer_type.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer_type.html new file mode 100644 index 0000000000..ab947cc003 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/lowest_layer_type.html @@ -0,0 +1,342 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="lowest_layer/overload2.html" title="windows::basic_random_access_handle::lowest_layer (2 of 2 overloads)"> +<link rel="next" href="native_handle.html" title="windows::basic_random_access_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_random_access_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_random_access_handle.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="windows::basic_random_access_handle::lowest_layer_type">windows::basic_random_access_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_random_access_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_random_access_handle.lowest_layer_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_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/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_random_access_handle.lowest_layer_type.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_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> + </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_random_access_handle.lowest_layer_type.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.protected_member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_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> + </p> + </td> +<td> + <p> + Protected destructor to prevent deletion through this type. + </p> + </td> +</tr></tbody> +</table></div> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.h3"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.protected_data_members"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.protected_data_members">Protected + Data Members</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/impl_.html" title="windows::basic_overlapped_handle::impl_"><span class="bold"><strong>impl_</strong></span></a> + </p> + </td> +<td> + </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_random_access_handle.lowest_layer_type.h4"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_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_random_access_handle.lowest_layer_type.h5"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_random_access_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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/native_handle.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/native_handle.html new file mode 100644 index 0000000000..fe7ad39810 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/native_handle.html @@ -0,0 +1,58 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="lowest_layer_type.html" title="windows::basic_random_access_handle::lowest_layer_type"> +<link rel="next" href="native_handle_type.html" title="windows::basic_random_access_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_random_access_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_random_access_handle.native_handle"></a><a class="link" href="native_handle.html" title="windows::basic_random_access_handle::native_handle">windows::basic_random_access_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_random_access_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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/native_handle_type.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/native_handle_type.html new file mode 100644 index 0000000000..fcde601920 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/native_handle_type.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="native_handle.html" title="windows::basic_random_access_handle::native_handle"> +<link rel="next" href="operator_eq_.html" title="windows::basic_random_access_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_random_access_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_random_access_handle.native_handle_type"></a><a class="link" href="native_handle_type.html" title="windows::basic_random_access_handle::native_handle_type">windows::basic_random_access_handle::native_handle_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_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_random_access_handle.native_handle_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.native_handle_type.requirements"></a></span><a class="link" href="native_handle_type.html#boost_asio.reference.windows__basic_random_access_handle.native_handle_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_random_access_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-2019 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_random_access_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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/operator_eq_.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/operator_eq_.html new file mode 100644 index 0000000000..ee52082e11 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/operator_eq_.html @@ -0,0 +1,77 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="native_handle_type.html" title="windows::basic_random_access_handle::native_handle_type"> +<link rel="next" href="read_some_at.html" title="windows::basic_random_access_handle::read_some_at"> +</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_random_access_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_at.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_random_access_handle.operator_eq_"></a><a class="link" href="operator_eq_.html" title="windows::basic_random_access_handle::operator=">windows::basic_random_access_handle::operator=</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_handle.operator_eq_"></a> +Move-assign + a random-access handle from another. + </p> +<pre class="programlisting">basic_random_access_handle & operator=( + basic_random_access_handle && other); +</pre> +<p> + This assignment operator moves a random-access handle from one object to + another. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.operator_eq_.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.operator_eq_.parameters"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.windows__basic_random_access_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 random-access handle object from which the move will occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.operator_eq_.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.operator_eq_.remarks"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.windows__basic_random_access_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_random_access_handle(const executor_type&)</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-2019 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_random_access_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_at.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at.html new file mode 100644 index 0000000000..c7c634db72 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::read_some_at</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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="operator_eq_.html" title="windows::basic_random_access_handle::operator="> +<link rel="next" href="read_some_at/overload1.html" title="windows::basic_random_access_handle::read_some_at (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_random_access_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_at/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_random_access_handle.read_some_at"></a><a class="link" href="read_some_at.html" title="windows::basic_random_access_handle::read_some_at">windows::basic_random_access_handle::read_some_at</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_handle.read_some_at"></a> +Read + some data from the handle at the specified offset. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> +std::size_t <a class="link" href="read_some_at/overload1.html" title="windows::basic_random_access_handle::read_some_at (1 of 2 overloads)">read_some_at</a>( + uint64_t offset, + const MutableBufferSequence & buffers); + <span class="emphasis"><em>» <a class="link" href="read_some_at/overload1.html" title="windows::basic_random_access_handle::read_some_at (1 of 2 overloads)">more...</a></em></span> + +template< + typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> +std::size_t <a class="link" href="read_some_at/overload2.html" title="windows::basic_random_access_handle::read_some_at (2 of 2 overloads)">read_some_at</a>( + uint64_t offset, + const MutableBufferSequence & buffers, + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="read_some_at/overload2.html" title="windows::basic_random_access_handle::read_some_at (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-2019 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_random_access_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_at/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at/overload1.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at/overload1.html new file mode 100644 index 0000000000..5c460035b2 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at/overload1.html @@ -0,0 +1,122 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::read_some_at (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_at.html" title="windows::basic_random_access_handle::read_some_at"> +<link rel="prev" href="../read_some_at.html" title="windows::basic_random_access_handle::read_some_at"> +<link rel="next" href="overload2.html" title="windows::basic_random_access_handle::read_some_at (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_at.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some_at.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_random_access_handle.read_some_at.overload1"></a><a class="link" href="overload1.html" title="windows::basic_random_access_handle::read_some_at (1 of 2 overloads)">windows::basic_random_access_handle::read_some_at + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Read some data from the handle at the specified offset. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> +std::size_t read_some_at( + uint64_t offset, + const MutableBufferSequence & buffers); +</pre> +<p> + This function is used to read data from the random-access 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_random_access_handle.read_some_at.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">offset</span></dt> +<dd><p> + The offset at which the data will be read. + </p></dd> +<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_random_access_handle.read_some_at.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of bytes read. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.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_random_access_handle.read_some_at.overload1.h3"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.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_at.html" title="read_at"><code class="computeroutput">read_at</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_random_access_handle.read_some_at.overload1.h4"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.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_at(42, 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-2019 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_at.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some_at.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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at/overload2.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at/overload2.html new file mode 100644 index 0000000000..15de07a306 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at/overload2.html @@ -0,0 +1,98 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::read_some_at (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_at.html" title="windows::basic_random_access_handle::read_some_at"> +<link rel="prev" href="overload1.html" title="windows::basic_random_access_handle::read_some_at (1 of 2 overloads)"> +<link rel="next" href="../write_some_at.html" title="windows::basic_random_access_handle::write_some_at"> +</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_at.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_at.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_random_access_handle.read_some_at.overload2"></a><a class="link" href="overload2.html" title="windows::basic_random_access_handle::read_some_at (2 of 2 overloads)">windows::basic_random_access_handle::read_some_at + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Read some data from the handle at the specified offset. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> +std::size_t read_some_at( + uint64_t offset, + const MutableBufferSequence & buffers, + boost::system::error_code & ec); +</pre> +<p> + This function is used to read data from the random-access 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_random_access_handle.read_some_at.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">offset</span></dt> +<dd><p> + The offset at which the data will be read. + </p></dd> +<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_random_access_handle.read_some_at.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.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_random_access_handle.read_some_at.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.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_at.html" title="read_at"><code class="computeroutput">read_at</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-2019 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_at.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_at.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/write_some_at.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/write_some_at.html new file mode 100644 index 0000000000..878a5ad0fd --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/write_some_at.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::write_some_at</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_random_access_handle.html" title="windows::basic_random_access_handle"> +<link rel="prev" href="read_some_at/overload2.html" title="windows::basic_random_access_handle::read_some_at (2 of 2 overloads)"> +<link rel="next" href="write_some_at/overload1.html" title="windows::basic_random_access_handle::write_some_at (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_at/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_at/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_random_access_handle.write_some_at"></a><a class="link" href="write_some_at.html" title="windows::basic_random_access_handle::write_some_at">windows::basic_random_access_handle::write_some_at</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_handle.write_some_at"></a> +Write + some data to the handle at the specified offset. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>> +std::size_t <a class="link" href="write_some_at/overload1.html" title="windows::basic_random_access_handle::write_some_at (1 of 2 overloads)">write_some_at</a>( + uint64_t offset, + const ConstBufferSequence & buffers); + <span class="emphasis"><em>» <a class="link" href="write_some_at/overload1.html" title="windows::basic_random_access_handle::write_some_at (1 of 2 overloads)">more...</a></em></span> + +template< + typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>> +std::size_t <a class="link" href="write_some_at/overload2.html" title="windows::basic_random_access_handle::write_some_at (2 of 2 overloads)">write_some_at</a>( + uint64_t offset, + const ConstBufferSequence & buffers, + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="write_some_at/overload2.html" title="windows::basic_random_access_handle::write_some_at (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-2019 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_at/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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_at/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/write_some_at/overload1.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/write_some_at/overload1.html new file mode 100644 index 0000000000..518dc60f4e --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/write_some_at/overload1.html @@ -0,0 +1,122 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::write_some_at (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_at.html" title="windows::basic_random_access_handle::write_some_at"> +<link rel="prev" href="../write_some_at.html" title="windows::basic_random_access_handle::write_some_at"> +<link rel="next" href="overload2.html" title="windows::basic_random_access_handle::write_some_at (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_at.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some_at.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_random_access_handle.write_some_at.overload1"></a><a class="link" href="overload1.html" title="windows::basic_random_access_handle::write_some_at (1 of 2 overloads)">windows::basic_random_access_handle::write_some_at + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Write some data to the handle at the specified offset. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>> +std::size_t write_some_at( + uint64_t offset, + const ConstBufferSequence & buffers); +</pre> +<p> + This function is used to write data to the random-access 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_random_access_handle.write_some_at.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">offset</span></dt> +<dd><p> + The offset at which the data will be written. + </p></dd> +<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_random_access_handle.write_some_at.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of bytes written. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload1.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.write_some_at.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_random_access_handle.write_some_at.overload1.h3"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload1.remarks">Remarks</a> + </h6> +<p> + The write_some_at operation may not write all of the data. Consider using + the <a class="link" href="../../write_at.html" title="write_at"><code class="computeroutput">write_at</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_random_access_handle.write_some_at.overload1.h4"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.write_some_at.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_at(42, 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-2019 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_at.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some_at.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> diff --git a/doc/html/boost_asio/reference/windows__basic_random_access_handle/write_some_at/overload2.html b/doc/html/boost_asio/reference/windows__basic_random_access_handle/write_some_at/overload2.html new file mode 100644 index 0000000000..fd3cb0f3ec --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_random_access_handle/write_some_at/overload2.html @@ -0,0 +1,98 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_random_access_handle::write_some_at (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_at.html" title="windows::basic_random_access_handle::write_some_at"> +<link rel="prev" href="overload1.html" title="windows::basic_random_access_handle::write_some_at (1 of 2 overloads)"> +<link rel="next" href="../../windows__basic_stream_handle.html" title="windows::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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some_at.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.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_random_access_handle.write_some_at.overload2"></a><a class="link" href="overload2.html" title="windows::basic_random_access_handle::write_some_at (2 of 2 overloads)">windows::basic_random_access_handle::write_some_at + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Write some data to the handle at the specified offset. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>> +std::size_t write_some_at( + uint64_t offset, + const ConstBufferSequence & buffers, + boost::system::error_code & ec); +</pre> +<p> + This function is used to write data to the random-access 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_random_access_handle.write_some_at.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">offset</span></dt> +<dd><p> + The offset at which the data will be written. + </p></dd> +<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_random_access_handle.write_some_at.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.write_some_at.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_random_access_handle.write_some_at.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.write_some_at.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.write_some_at.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_at.html" title="write_at"><code class="computeroutput">write_at</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-2019 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_at.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.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |