diff options
author | DongHun Kwak <dh0128.kwak@samsung.com> | 2017-09-13 11:08:07 +0900 |
---|---|---|
committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2017-09-13 11:09:00 +0900 |
commit | b5c87084afaef42b2d058f68091be31988a6a874 (patch) | |
tree | adef9a65870a41181687e11d57fdf98e7629de3c /doc/html/boost_asio/reference/windows__basic_stream_handle | |
parent | 34bd32e225e2a8a94104489b31c42e5801cc1f4a (diff) | |
download | boost-b5c87084afaef42b2d058f68091be31988a6a874.tar.gz boost-b5c87084afaef42b2d058f68091be31988a6a874.tar.bz2 boost-b5c87084afaef42b2d058f68091be31988a6a874.zip |
Imported Upstream version 1.64.0upstream/1.64.0
Change-Id: Id9212edd016dd55f21172c427aa7894d1d24148b
Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/boost_asio/reference/windows__basic_stream_handle')
42 files changed, 3226 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/assign.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/assign.html new file mode 100644 index 0000000000..cc5cad3a8e --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/assign.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::assign</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="next" href="assign/overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="assign/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.assign"></a><a class="link" href="assign.html" title="windows::basic_stream_handle::assign">windows::basic_stream_handle::assign</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp176895360"></a> +Assign an existing native handle to the + handle. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="assign/overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)">assign</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">handle</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="assign/overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <a class="link" href="assign/overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)">assign</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">handle</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="assign/overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="assign/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/assign/overload1.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/assign/overload1.html new file mode 100644 index 0000000000..a2ae4a15c8 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/assign/overload1.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::assign (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../assign.html" title="windows::basic_stream_handle::assign"> +<link rel="prev" href="../assign.html" title="windows::basic_stream_handle::assign"> +<link rel="next" href="overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../assign.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.assign.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)">windows::basic_stream_handle::assign + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + Assign an existing native handle to the handle. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">assign</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">handle</span><span class="special">);</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-2017 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_stream_handle/assign/overload2.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/assign/overload2.html new file mode 100644 index 0000000000..97aaa1cd63 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/assign/overload2.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::assign (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../assign.html" title="windows::basic_stream_handle::assign"> +<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::assign (1 of 2 overloads)"> +<link rel="next" href="../async_read_some.html" title="windows::basic_stream_handle::async_read_some"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../async_read_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.assign.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)">windows::basic_stream_handle::assign + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + Assign an existing native handle to the handle. + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">assign</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">handle</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../async_read_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/async_read_some.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/async_read_some.html new file mode 100644 index 0000000000..71b98900a0 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/async_read_some.html @@ -0,0 +1,117 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::async_read_some</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="assign/overload2.html" title="windows::basic_stream_handle::assign (2 of 2 overloads)"> +<link rel="next" href="async_write_some.html" title="windows::basic_stream_handle::async_write_some"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.async_read_some"></a><a class="link" href="async_read_some.html" title="windows::basic_stream_handle::async_read_some">windows::basic_stream_handle::async_read_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp176940048"></a> +Start an asynchronous read. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span> + <span class="keyword">typename</span> <a class="link" href="../ReadHandler.html" title="Read handler requirements">ReadHandler</a><span class="special">></span> +<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <span class="identifier">async_read_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> + <span class="identifier">ReadHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to asynchronously read data from the stream handle. + The function call always returns immediately. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.parameters"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.windows__basic_stream_handle.async_read_some.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more buffers into which the data will be read. Although the + buffers object may be copied as necessary, ownership of the underlying + memory blocks is retained by the caller, which must guarantee that + they remain valid until the handler is called. + </p></dd> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called when the read operation completes. Copies + will be made of the handler as required. The function signature of + the handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span><span class="special">,</span> <span class="comment">// Result of operation.</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span> <span class="comment">// Number of bytes read.</span> +<span class="special">);</span> +</pre> +<p> + Regardless of whether the asynchronous operation completes immediately + or not, the handler will not be invoked from within this function. + Invocation of the handler will be performed in a manner equivalent + to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>. + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.remarks"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.windows__basic_stream_handle.async_read_some.remarks">Remarks</a> + </h6> +<p> + The read operation may not read all of the requested number of bytes. Consider + using the <a class="link" href="../async_read.html" title="async_read"><code class="computeroutput"><span class="identifier">async_read</span></code></a> function if you need + to ensure that the requested amount of data is read before the asynchronous + operation completes. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_read_some.example"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.windows__basic_stream_handle.async_read_some.example">Example</a> + </h6> +<p> + To read into a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows: + </p> +<pre class="programlisting"><span class="identifier">handle</span><span class="special">.</span><span class="identifier">async_read_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">),</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/async_write_some.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/async_write_some.html new file mode 100644 index 0000000000..50acd726f3 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/async_write_some.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::async_write_some</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="async_read_some.html" title="windows::basic_stream_handle::async_read_some"> +<link rel="next" href="basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_stream_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.async_write_some"></a><a class="link" href="async_write_some.html" title="windows::basic_stream_handle::async_write_some">windows::basic_stream_handle::async_write_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp176997536"></a> +Start an asynchronous write. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">,</span> + <span class="keyword">typename</span> <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a><span class="special">></span> +<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <span class="identifier">async_write_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> + <span class="identifier">WriteHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to asynchronously write data to the stream handle. + The function call always returns immediately. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.windows__basic_stream_handle.async_write_some.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more data buffers to be written to the handle. Although the + buffers object may be copied as necessary, ownership of the underlying + memory blocks is retained by the caller, which must guarantee that + they remain valid until the handler is called. + </p></dd> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called when the write operation completes. Copies + will be made of the handler as required. The function signature of + the handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span><span class="special">,</span> <span class="comment">// Result of operation.</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span> <span class="comment">// Number of bytes written.</span> +<span class="special">);</span> +</pre> +<p> + Regardless of whether the asynchronous operation completes immediately + or not, the handler will not be invoked from within this function. + Invocation of the handler will be performed in a manner equivalent + to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>. + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.remarks"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.windows__basic_stream_handle.async_write_some.remarks">Remarks</a> + </h6> +<p> + The write operation may not transmit all of the data to the peer. Consider + using the <a class="link" href="../async_write.html" title="async_write"><code class="computeroutput"><span class="identifier">async_write</span></code></a> function if you need + to ensure that all data is written before the asynchronous operation completes. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.async_write_some.example"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.windows__basic_stream_handle.async_write_some.example">Example</a> + </h6> +<p> + To write a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows: + </p> +<pre class="programlisting"><span class="identifier">handle</span><span class="special">.</span><span class="identifier">async_write_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">),</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_stream_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle.html new file mode 100644 index 0000000000..29efba4f51 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle.html @@ -0,0 +1,68 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::basic_stream_handle</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="async_write_some.html" title="windows::basic_stream_handle::async_write_some"> +<link rel="next" href="basic_stream_handle/overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="async_write_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_stream_handle/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle"></a><a class="link" href="basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle">windows::basic_stream_handle::basic_stream_handle</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177055008"></a> +Construct a <a class="link" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> without opening + it. + </p> +<pre class="programlisting"><span class="keyword">explicit</span> <a class="link" href="basic_stream_handle/overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 3 overloads)">basic_stream_handle</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_stream_handle/overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Construct a <a class="link" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> on an existing + native handle. + </p> +<pre class="programlisting"><a class="link" href="basic_stream_handle/overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 3 overloads)">basic_stream_handle</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">handle</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_stream_handle/overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Move-construct a <a class="link" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> from another. + </p> +<pre class="programlisting"><a class="link" href="basic_stream_handle/overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 3 overloads)">basic_stream_handle</a><span class="special">(</span> + <span class="identifier">basic_stream_handle</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_stream_handle/overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 3 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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="async_write_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_stream_handle/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle/overload1.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle/overload1.html new file mode 100644 index 0000000000..90d9977a31 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle/overload1.html @@ -0,0 +1,71 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::basic_stream_handle (1 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle"> +<link rel="prev" href="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle"> +<link rel="next" href="overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 3 overloads)">windows::basic_stream_handle::basic_stream_handle + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> without + opening it. + </p> +<pre class="programlisting"><span class="identifier">basic_stream_handle</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">);</span> +</pre> +<p> + This constructor creates a stream handle without opening it. The handle + needs to be opened and then connected or accepted before data can be + sent or received on it. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the stream handle will use to dispatch handlers for any asynchronous + operations performed on the 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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle/overload2.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle/overload2.html new file mode 100644 index 0000000000..f19a6cfd67 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle/overload2.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::basic_stream_handle (2 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle"> +<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::basic_stream_handle (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 3 overloads)">windows::basic_stream_handle::basic_stream_handle + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> on an existing + native handle. + </p> +<pre class="programlisting"><span class="identifier">basic_stream_handle</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">handle</span><span class="special">);</span> +</pre> +<p> + This constructor creates a stream handle object to hold an existing native + handle. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the stream handle will use to dispatch handlers for any asynchronous + operations performed on the handle. + </p></dd> +<dt><span class="term">handle</span></dt> +<dd><p> + The new underlying handle implementation. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload2.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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle/overload3.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle/overload3.html new file mode 100644 index 0000000000..56e0071897 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/basic_stream_handle/overload3.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::basic_stream_handle (3 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle"> +<link rel="prev" href="overload2.html" title="windows::basic_stream_handle::basic_stream_handle (2 of 3 overloads)"> +<link rel="next" href="../cancel.html" title="windows::basic_stream_handle::cancel"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../cancel.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3"></a><a class="link" href="overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 3 overloads)">windows::basic_stream_handle::basic_stream_handle + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + Move-construct a <a class="link" href="../../windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> from another. + </p> +<pre class="programlisting"><span class="identifier">basic_stream_handle</span><span class="special">(</span> + <span class="identifier">basic_stream_handle</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">);</span> +</pre> +<p> + This constructor moves a stream handle from one object to another. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">other</span></dt> +<dd><p> + The other <a class="link" href="../../windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> object + from which the move will occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.windows__basic_stream_handle.basic_stream_handle.overload3.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"><span class="identifier">basic_stream_handle</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">&)</span> <span class="identifier">constructor</span></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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_handle.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../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_stream_handle/cancel.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/cancel.html new file mode 100644 index 0000000000..4de4e5d670 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/cancel.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::cancel</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="basic_stream_handle/overload3.html" title="windows::basic_stream_handle::basic_stream_handle (3 of 3 overloads)"> +<link rel="next" href="cancel/overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="basic_stream_handle/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.cancel"></a><a class="link" href="cancel.html" title="windows::basic_stream_handle::cancel">windows::basic_stream_handle::cancel</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177155472"></a> +Cancel all asynchronous operations associated + with the handle. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="cancel/overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)">cancel</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <a class="link" href="cancel/overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)">cancel</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="basic_stream_handle/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/cancel/overload1.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/cancel/overload1.html new file mode 100644 index 0000000000..82fa86c638 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/cancel/overload1.html @@ -0,0 +1,70 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::cancel (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../cancel.html" title="windows::basic_stream_handle::cancel"> +<link rel="prev" href="../cancel.html" title="windows::basic_stream_handle::cancel"> +<link rel="next" href="overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)">windows::basic_stream_handle::cancel + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + Cancel all asynchronous operations associated with the handle. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">cancel</span><span class="special">();</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.cancel.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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_stream_handle/cancel/overload2.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/cancel/overload2.html new file mode 100644 index 0000000000..9d172b864b --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/cancel/overload2.html @@ -0,0 +1,71 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::cancel (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../cancel.html" title="windows::basic_stream_handle::cancel"> +<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::cancel (1 of 2 overloads)"> +<link rel="next" href="../close.html" title="windows::basic_stream_handle::close"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../close.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)">windows::basic_stream_handle::cancel + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + Cancel all asynchronous operations associated with the handle. + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">cancel</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.cancel.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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_stream_handle/close.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/close.html new file mode 100644 index 0000000000..85c7143a4f --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/close.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::close</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="cancel/overload2.html" title="windows::basic_stream_handle::cancel (2 of 2 overloads)"> +<link rel="next" href="close/overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="cancel/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="close/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.close"></a><a class="link" href="close.html" title="windows::basic_stream_handle::close">windows::basic_stream_handle::close</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177211024"></a> +Close the handle. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="close/overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)">close</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="close/overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <a class="link" href="close/overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)">close</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="close/overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="cancel/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="close/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/close/overload1.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/close/overload1.html new file mode 100644 index 0000000000..9e3f35efa5 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/close/overload1.html @@ -0,0 +1,70 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::close (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../close.html" title="windows::basic_stream_handle::close"> +<link rel="prev" href="../close.html" title="windows::basic_stream_handle::close"> +<link rel="next" href="overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../close.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.close.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)">windows::basic_stream_handle::close + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + Close the handle. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">close</span><span class="special">();</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.close.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.close.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.close.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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_stream_handle/close/overload2.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/close/overload2.html new file mode 100644 index 0000000000..396e6a64a8 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/close/overload2.html @@ -0,0 +1,71 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::close (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../close.html" title="windows::basic_stream_handle::close"> +<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::close (1 of 2 overloads)"> +<link rel="next" href="../get_implementation.html" title="windows::basic_stream_handle::get_implementation"> +</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="../get_implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.close.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)">windows::basic_stream_handle::close + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + Close the handle. + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">close</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.close.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.close.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.close.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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="../get_implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/get_implementation.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_implementation.html new file mode 100644 index 0000000000..c0a6548d31 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_implementation.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::get_implementation</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="close/overload2.html" title="windows::basic_stream_handle::close (2 of 2 overloads)"> +<link rel="next" href="get_implementation/overload1.html" title="windows::basic_stream_handle::get_implementation (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="close/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_implementation/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.get_implementation"></a><a class="link" href="get_implementation.html" title="windows::basic_stream_handle::get_implementation">windows::basic_stream_handle::get_implementation</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177267664"></a> +Get the underlying implementation + of the I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="special">&</span> <a class="link" href="get_implementation/overload1.html" title="windows::basic_stream_handle::get_implementation (1 of 2 overloads)">get_implementation</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="get_implementation/overload1.html" title="windows::basic_stream_handle::get_implementation (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">const</span> <span class="identifier">implementation_type</span> <span class="special">&</span> <a class="link" href="get_implementation/overload2.html" title="windows::basic_stream_handle::get_implementation (2 of 2 overloads)">get_implementation</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_implementation/overload2.html" title="windows::basic_stream_handle::get_implementation (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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="close/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_implementation/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_stream_handle/get_implementation/overload1.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_implementation/overload1.html new file mode 100644 index 0000000000..07e6712950 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_implementation/overload1.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::get_implementation (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="../get_implementation.html" title="windows::basic_stream_handle::get_implementation"> +<link rel="prev" href="../get_implementation.html" title="windows::basic_stream_handle::get_implementation"> +<link rel="next" href="overload2.html" title="windows::basic_stream_handle::get_implementation (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="../get_implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.get_implementation.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::get_implementation (1 of 2 overloads)">windows::basic_stream_handle::get_implementation + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="special">&</span> <span class="identifier">get_implementation</span><span class="special">();</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-2017 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_implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.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_stream_handle/get_implementation/overload2.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_implementation/overload2.html new file mode 100644 index 0000000000..3057d34874 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_implementation/overload2.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::get_implementation (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="../get_implementation.html" title="windows::basic_stream_handle::get_implementation"> +<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::get_implementation (1 of 2 overloads)"> +<link rel="next" href="../get_io_service.html" title="windows::basic_stream_handle::get_io_service"> +</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="../get_implementation.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_io_service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.get_implementation.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::get_implementation (2 of 2 overloads)">windows::basic_stream_handle::get_implementation + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">implementation_type</span> <span class="special">&</span> <span class="identifier">get_implementation</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</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-2017 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="../get_implementation.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_io_service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/get_io_service.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_io_service.html new file mode 100644 index 0000000000..c9038c2495 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_io_service.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::get_io_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="get_implementation/overload2.html" title="windows::basic_stream_handle::get_implementation (2 of 2 overloads)"> +<link rel="next" href="get_service.html" title="windows::basic_stream_handle::get_service"> +</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_implementation/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.get_io_service"></a><a class="link" href="get_io_service.html" title="windows::basic_stream_handle::get_io_service">windows::basic_stream_handle::get_io_service</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp177298128"></a> +Get the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> associated with the + object. + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">get_io_service</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the I/O + object uses to dispatch handlers for asynchronous operations. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.get_io_service.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.get_io_service.return_value"></a></span><a class="link" href="get_io_service.html#boost_asio.reference.windows__basic_stream_handle.get_io_service.return_value">Return + Value</a> + </h6> +<p> + A reference to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the I/O + object will use to dispatch handlers. 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-2017 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_implementation/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/get_service.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_service.html new file mode 100644 index 0000000000..241a73d0cf --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_service.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::get_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="get_io_service.html" title="windows::basic_stream_handle::get_io_service"> +<link rel="next" href="get_service/overload1.html" title="windows::basic_stream_handle::get_service (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="get_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_service/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.get_service"></a><a class="link" href="get_service.html" title="windows::basic_stream_handle::get_service">windows::basic_stream_handle::get_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177316496"></a> +Get the service associated with + the I/O object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <a class="link" href="get_service/overload1.html" title="windows::basic_stream_handle::get_service (1 of 2 overloads)">get_service</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="get_service/overload1.html" title="windows::basic_stream_handle::get_service (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">const</span> <span class="identifier">service_type</span> <span class="special">&</span> <a class="link" href="get_service/overload2.html" title="windows::basic_stream_handle::get_service (2 of 2 overloads)">get_service</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_service/overload2.html" title="windows::basic_stream_handle::get_service (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-2017 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_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_service/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_stream_handle/get_service/overload1.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_service/overload1.html new file mode 100644 index 0000000000..c637b4f292 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_service/overload1.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::get_service (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="../get_service.html" title="windows::basic_stream_handle::get_service"> +<link rel="prev" href="../get_service.html" title="windows::basic_stream_handle::get_service"> +<link rel="next" href="overload2.html" title="windows::basic_stream_handle::get_service (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="../get_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.get_service.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::get_service (1 of 2 overloads)">windows::basic_stream_handle::get_service + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the service associated with the I/O object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">get_service</span><span class="special">();</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-2017 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_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.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_stream_handle/get_service/overload2.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_service/overload2.html new file mode 100644 index 0000000000..658f033dd3 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/get_service/overload2.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::get_service (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="../get_service.html" title="windows::basic_stream_handle::get_service"> +<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::get_service (1 of 2 overloads)"> +<link rel="next" href="../implementation.html" title="windows::basic_stream_handle::implementation"> +</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="../get_service.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="../implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.get_service.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::get_service (2 of 2 overloads)">windows::basic_stream_handle::get_service + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the service associated with the I/O object. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">get_service</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</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-2017 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="../get_service.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="../implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/implementation.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/implementation.html new file mode 100644 index 0000000000..7fa4f0cbb6 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/implementation.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::implementation</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="get_service/overload2.html" title="windows::basic_stream_handle::get_service (2 of 2 overloads)"> +<link rel="next" href="implementation_type.html" title="windows::basic_stream_handle::implementation_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="get_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="implementation_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.implementation"></a><a class="link" href="implementation.html" title="windows::basic_stream_handle::implementation">windows::basic_stream_handle::implementation</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp177346656"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">get_implementation</span><span class="special">()</span></code>.) + The underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="identifier">implementation</span><span class="special">;</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-2017 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_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="implementation_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_stream_handle/implementation_type.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/implementation_type.html new file mode 100644 index 0000000000..be40cd8ad2 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/implementation_type.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::implementation_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="implementation.html" title="windows::basic_stream_handle::implementation"> +<link rel="next" href="is_open.html" title="windows::basic_stream_handle::is_open"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_open.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.implementation_type"></a><a class="link" href="implementation_type.html" title="windows::basic_stream_handle::implementation_type">windows::basic_stream_handle::implementation_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp177355328"></a> +The underlying implementation + type of I/O object. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">service_type</span><span class="special">::</span><span class="identifier">implementation_type</span> <span class="identifier">implementation_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.implementation_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.implementation_type.requirements"></a></span><a class="link" href="implementation_type.html#boost_asio.reference.windows__basic_stream_handle.implementation_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_stream_handle.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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="implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_open.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/is_open.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/is_open.html new file mode 100644 index 0000000000..3809c5c704 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/is_open.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::is_open</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="implementation_type.html" title="windows::basic_stream_handle::implementation_type"> +<link rel="next" href="lowest_layer.html" title="windows::basic_stream_handle::lowest_layer"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="implementation_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lowest_layer.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.is_open"></a><a class="link" href="is_open.html" title="windows::basic_stream_handle::is_open">windows::basic_stream_handle::is_open</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + <a class="indexterm" name="idp177369584"></a> +Determine whether the handle is open. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">is_open</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</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-2017 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="implementation_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="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_stream_handle/lowest_layer.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/lowest_layer.html new file mode 100644 index 0000000000..106c6ef061 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/lowest_layer.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::lowest_layer</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="is_open.html" title="windows::basic_stream_handle::is_open"> +<link rel="next" href="lowest_layer/overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="is_open.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lowest_layer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer"></a><a class="link" href="lowest_layer.html" title="windows::basic_stream_handle::lowest_layer">windows::basic_stream_handle::lowest_layer</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177376928"></a> +Get a reference to the lowest layer. + </p> +<pre class="programlisting"><span class="identifier">lowest_layer_type</span> <span class="special">&</span> <a class="link" href="lowest_layer/overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)">lowest_layer</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="lowest_layer/overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)">more...</a></em></span> +</pre> +<p> + Get a const reference to the lowest layer. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">lowest_layer_type</span> <span class="special">&</span> <a class="link" href="lowest_layer/overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)">lowest_layer</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="lowest_layer/overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="is_open.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lowest_layer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/lowest_layer/overload1.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/lowest_layer/overload1.html new file mode 100644 index 0000000000..30a96a3778 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_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_stream_handle::lowest_layer (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../lowest_layer.html" title="windows::basic_stream_handle::lowest_layer"> +<link rel="prev" href="../lowest_layer.html" title="windows::basic_stream_handle::lowest_layer"> +<link rel="next" href="overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../lowest_layer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)">windows::basic_stream_handle::lowest_layer + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + Get a reference to the lowest layer. + </p> +<pre class="programlisting"><span class="identifier">lowest_layer_type</span> <span class="special">&</span> <span class="identifier">lowest_layer</span><span class="special">();</span> +</pre> +<p> + This function returns a reference to the lowest layer in a stack of layers. + Since a <a class="link" href="../../windows__basic_handle.html" title="windows::basic_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_handle</span></code></a> cannot contain + any further layers, it simply returns a reference to itself. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload1.return_value">Return + Value</a> + </h6> +<p> + A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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_stream_handle/lowest_layer/overload2.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/lowest_layer/overload2.html new file mode 100644 index 0000000000..b2467c4101 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_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_stream_handle::lowest_layer (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../lowest_layer.html" title="windows::basic_stream_handle::lowest_layer"> +<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::lowest_layer (1 of 2 overloads)"> +<link rel="next" href="../lowest_layer_type.html" title="windows::basic_stream_handle::lowest_layer_type"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../lowest_layer_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)">windows::basic_stream_handle::lowest_layer + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + Get a const reference to the lowest layer. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">lowest_layer_type</span> <span class="special">&</span> <span class="identifier">lowest_layer</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function returns a const reference to the lowest layer in a stack + of layers. Since a <a class="link" href="../../windows__basic_handle.html" title="windows::basic_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_handle</span></code></a> cannot contain + any further layers, it simply returns a reference to itself. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer.overload2.return_value">Return + Value</a> + </h6> +<p> + A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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_stream_handle/lowest_layer_type.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/lowest_layer_type.html new file mode 100644 index 0000000000..426c5d923e --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/lowest_layer_type.html @@ -0,0 +1,429 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::lowest_layer_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="lowest_layer/overload2.html" title="windows::basic_stream_handle::lowest_layer (2 of 2 overloads)"> +<link rel="next" href="native.html" title="windows::basic_stream_handle::native"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="windows::basic_stream_handle::lowest_layer_type">windows::basic_stream_handle::lowest_layer_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + <a class="indexterm" name="idp177422208"></a> +A <a class="link" href="../windows__basic_handle.html" title="windows::basic_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_handle</span></code></a> is always the lowest + layer. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_handle</span><span class="special"><</span> <span class="identifier">StreamHandleService</span> <span class="special">></span> <span class="identifier">lowest_layer_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.types">Types</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/implementation_type.html" title="windows::basic_handle::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a> + </p> + </td> +<td> + <p> + The underlying implementation type of I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/lowest_layer_type.html" title="windows::basic_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a> + </p> + </td> +<td> + <p> + A basic_handle is always the lowest layer. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/native_handle_type.html" title="windows::basic_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> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/native_type.html" title="windows::basic_handle::native_type"><span class="bold"><strong>native_type</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use native_handle_type.) The native representation + of a handle. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/service_type.html" title="windows::basic_handle::service_type"><span class="bold"><strong>service_type</strong></span></a> + </p> + </td> +<td> + <p> + The type of the service that will be used to provide I/O operations. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.member_functions">Member + Functions</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/assign.html" title="windows::basic_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_handle/basic_handle.html" title="windows::basic_handle::basic_handle"><span class="bold"><strong>basic_handle</strong></span></a> + </p> + </td> +<td> + <p> + Construct a basic_handle without opening it. + </p> + <p> + Construct a basic_handle on an existing native handle. + </p> + <p> + Move-construct a basic_handle from another. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/cancel.html" title="windows::basic_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_handle/close.html" title="windows::basic_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_handle/get_io_service.html" title="windows::basic_handle::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a> + </p> + </td> +<td> + <p> + Get the io_service associated with the object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/is_open.html" title="windows::basic_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_handle/lowest_layer.html" title="windows::basic_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a> + </p> + </td> +<td> + <p> + Get a reference to the lowest layer. + </p> + <p> + Get a const reference to the lowest layer. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/native.html" title="windows::basic_handle::native"><span class="bold"><strong>native</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use native_handle().) Get the native handle representation. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/native_handle.html" title="windows::basic_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_handle/operator_eq_.html" title="windows::basic_handle::operator="><span class="bold"><strong>operator=</strong></span></a> + </p> + </td> +<td> + <p> + Move-assign a basic_handle from another. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.protected_member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.protected_member_functions">Protected + Member Functions</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/get_implementation.html" title="windows::basic_handle::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a> + </p> + </td> +<td> + <p> + Get the underlying implementation of the I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/get_service.html" title="windows::basic_handle::get_service"><span class="bold"><strong>get_service</strong></span></a> + </p> + </td> +<td> + <p> + Get the service associated with the I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/_basic_handle.html" title="windows::basic_handle::~basic_handle"><span class="bold"><strong>~basic_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_stream_handle.lowest_layer_type.h3"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.protected_data_members"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_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_handle/implementation.html" title="windows::basic_handle::implementation"><span class="bold"><strong>implementation</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use get_implementation().) The underlying implementation + of the I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../windows__basic_handle/service.html" title="windows::basic_handle::service"><span class="bold"><strong>service</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use get_service().) The service associated with + the I/O object. + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + The <a class="link" href="../windows__basic_handle.html" title="windows::basic_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_handle</span></code></a> class template provides + the ability to wrap a Windows handle. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h4"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.thread_safety">Thread + Safety</a> + </h6> +<p> + <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. + </p> +<p> + <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.h5"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_stream_handle.lowest_layer_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_stream_handle.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/native.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/native.html new file mode 100644 index 0000000000..84004b7851 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/native.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::native</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="lowest_layer_type.html" title="windows::basic_stream_handle::lowest_layer_type"> +<link rel="next" href="native_handle.html" title="windows::basic_stream_handle::native_handle"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lowest_layer_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.native"></a><a class="link" href="native.html" title="windows::basic_stream_handle::native">windows::basic_stream_handle::native</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + <a class="indexterm" name="idp177544512"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">native_handle</span><span class="special">()</span></code>.) Get the native handle representation. + </p> +<pre class="programlisting"><span class="identifier">native_type</span> <span class="identifier">native</span><span class="special">();</span> +</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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lowest_layer_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/native_handle.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/native_handle.html new file mode 100644 index 0000000000..6a9836ac7e --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/native_handle.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::native_handle</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="native.html" title="windows::basic_stream_handle::native"> +<link rel="next" href="native_handle_type.html" title="windows::basic_stream_handle::native_handle_type"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="native.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native_handle_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.native_handle"></a><a class="link" href="native_handle.html" title="windows::basic_stream_handle::native_handle">windows::basic_stream_handle::native_handle</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from windows::basic_handle.</em></span> + </p> +<p> + <a class="indexterm" name="idp177553792"></a> +Get the native handle representation. + </p> +<pre class="programlisting"><span class="identifier">native_handle_type</span> <span class="identifier">native_handle</span><span class="special">();</span> +</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-2017 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.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native_handle_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/native_handle_type.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/native_handle_type.html new file mode 100644 index 0000000000..aebf1faded --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_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_stream_handle::native_handle_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="native_handle.html" title="windows::basic_stream_handle::native_handle"> +<link rel="next" href="native_type.html" title="windows::basic_stream_handle::native_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="native_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.native_handle_type"></a><a class="link" href="native_handle_type.html" title="windows::basic_stream_handle::native_handle_type">windows::basic_stream_handle::native_handle_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177560464"></a> +The native representation + of a handle. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">StreamHandleService</span><span class="special">::</span><span class="identifier">native_handle_type</span> <span class="identifier">native_handle_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.native_handle_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.native_handle_type.requirements"></a></span><a class="link" href="native_handle_type.html#boost_asio.reference.windows__basic_stream_handle.native_handle_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_stream_handle.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="native_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native_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_stream_handle/native_type.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/native_type.html new file mode 100644 index 0000000000..85fee84c79 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/native_type.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::native_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="native_handle_type.html" title="windows::basic_stream_handle::native_handle_type"> +<link rel="next" href="operator_eq_.html" title="windows::basic_stream_handle::operator="> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="native_handle_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="operator_eq_.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.native_type"></a><a class="link" href="native_type.html" title="windows::basic_stream_handle::native_type">windows::basic_stream_handle::native_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177574016"></a> +(Deprecated: Use native_handle_type.) + The native representation of a handle. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">StreamHandleService</span><span class="special">::</span><span class="identifier">native_handle_type</span> <span class="identifier">native_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.native_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.native_type.requirements"></a></span><a class="link" href="native_type.html#boost_asio.reference.windows__basic_stream_handle.native_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_stream_handle.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="native_handle_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="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_stream_handle/operator_eq_.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/operator_eq_.html new file mode 100644 index 0000000000..baa2f01d4a --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/operator_eq_.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::operator=</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="native_type.html" title="windows::basic_stream_handle::native_type"> +<link rel="next" href="read_some.html" title="windows::basic_stream_handle::read_some"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="native_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_"></a><a class="link" href="operator_eq_.html" title="windows::basic_stream_handle::operator=">windows::basic_stream_handle::operator=</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177587472"></a> +Move-assign a <a class="link" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> from another. + </p> +<pre class="programlisting"><span class="identifier">basic_stream_handle</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> + <span class="identifier">basic_stream_handle</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">);</span> +</pre> +<p> + This assignment operator moves a stream handle from one object to another. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_.parameters"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.windows__basic_stream_handle.operator_eq_.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">other</span></dt> +<dd><p> + The other <a class="link" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> object + from which the move will occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.operator_eq_.remarks"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.windows__basic_stream_handle.operator_eq_.remarks">Remarks</a> + </h6> +<p> + Following the move, the moved-from object is in the same state as if constructed + using the <code class="computeroutput"><span class="identifier">basic_stream_handle</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">&)</span> <span class="identifier">constructor</span></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-2017 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_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/read_some.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/read_some.html new file mode 100644 index 0000000000..63e841d467 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/read_some.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::read_some</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="operator_eq_.html" title="windows::basic_stream_handle::operator="> +<link rel="next" href="read_some/overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="operator_eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some"></a><a class="link" href="read_some.html" title="windows::basic_stream_handle::read_some">windows::basic_stream_handle::read_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177615184"></a> +Read some data from the handle. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_some/overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)">read_some</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="read_some/overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_some/overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)">read_some</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="read_some/overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="operator_eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/read_some/overload1.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/read_some/overload1.html new file mode 100644 index 0000000000..e39685e757 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/read_some/overload1.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::read_some (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../read_some.html" title="windows::basic_stream_handle::read_some"> +<link rel="prev" href="../read_some.html" title="windows::basic_stream_handle::read_some"> +<link rel="next" href="overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)">windows::basic_stream_handle::read_some + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Read some data from the handle. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">read_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span> +</pre> +<p> + This function is used to read data from the stream handle. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more buffers into which the data will be read. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of bytes read. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. An error code of <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">eof</span></code> + indicates that the connection was closed by the peer. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h3"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.remarks">Remarks</a> + </h6> +<p> + The read_some operation may not read all of the requested number of bytes. + Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput"><span class="identifier">read</span></code></a> function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.h4"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload1.example">Example</a> + </h6> +<p> + To read into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows: + </p> +<pre class="programlisting"><span class="identifier">handle</span><span class="special">.</span><span class="identifier">read_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">));</span> +</pre> +<p> + See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/read_some/overload2.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/read_some/overload2.html new file mode 100644 index 0000000000..f5fb93b040 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/read_some/overload2.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::read_some (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../read_some.html" title="windows::basic_stream_handle::read_some"> +<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::read_some (1 of 2 overloads)"> +<link rel="next" href="../service.html" title="windows::basic_stream_handle::service"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)">windows::basic_stream_handle::read_some + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Read some data from the handle. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">read_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</pre> +<p> + This function is used to read data from the stream handle. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more buffers into which the data will be read. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of bytes read. Returns 0 if an error occurred. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.read_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.read_some.overload2.remarks">Remarks</a> + </h6> +<p> + The read_some operation may not read all of the requested number of bytes. + Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput"><span class="identifier">read</span></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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/service.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/service.html new file mode 100644 index 0000000000..129a83cb32 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/service.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="read_some/overload2.html" title="windows::basic_stream_handle::read_some (2 of 2 overloads)"> +<link rel="next" href="service_type.html" title="windows::basic_stream_handle::service_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="read_some/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="service_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.service"></a><a class="link" href="service.html" title="windows::basic_stream_handle::service">windows::basic_stream_handle::service</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp177734224"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">get_service</span><span class="special">()</span></code>.) The service associated with the I/O + object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">service</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.service.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.service.remarks"></a></span><a class="link" href="service.html#boost_asio.reference.windows__basic_stream_handle.service.remarks">Remarks</a> + </h6> +<p> + Available only for services that do not support movability. + </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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_some/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="service_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_stream_handle/service_type.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/service_type.html new file mode 100644 index 0000000000..1909a7e649 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/service_type.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::service_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="service.html" title="windows::basic_stream_handle::service"> +<link rel="next" href="write_some.html" title="windows::basic_stream_handle::write_some"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.service_type"></a><a class="link" href="service_type.html" title="windows::basic_stream_handle::service_type">windows::basic_stream_handle::service_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp177746928"></a> +The type of the service that will + be used to provide I/O operations. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">StreamHandleService</span> <span class="identifier">service_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.service_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.service_type.requirements"></a></span><a class="link" href="service_type.html#boost_asio.reference.windows__basic_stream_handle.service_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_stream_handle.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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="service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/write_some.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/write_some.html new file mode 100644 index 0000000000..dfc104dce1 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/write_some.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::write_some</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../windows__basic_stream_handle.html" title="windows::basic_stream_handle"> +<link rel="prev" href="service_type.html" title="windows::basic_stream_handle::service_type"> +<link rel="next" href="write_some/overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="service_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some"></a><a class="link" href="write_some.html" title="windows::basic_stream_handle::write_some">windows::basic_stream_handle::write_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp177759456"></a> +Write some data to the handle. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="write_some/overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)">write_some</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="write_some/overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="write_some/overload2.html" title="windows::basic_stream_handle::write_some (2 of 2 overloads)">write_some</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="write_some/overload2.html" title="windows::basic_stream_handle::write_some (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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="service_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_stream_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_some/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_stream_handle/write_some/overload1.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/write_some/overload1.html new file mode 100644 index 0000000000..53f9dcf33c --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/write_some/overload1.html @@ -0,0 +1,115 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::write_some (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../write_some.html" title="windows::basic_stream_handle::write_some"> +<link rel="prev" href="../write_some.html" title="windows::basic_stream_handle::write_some"> +<link rel="next" href="overload2.html" title="windows::basic_stream_handle::write_some (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../write_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1"></a><a class="link" href="overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)">windows::basic_stream_handle::write_some + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Write some data to the handle. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">write_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span> +</pre> +<p> + This function is used to write data to the stream handle. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more data buffers to be written to the handle. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of bytes written. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. An error code of <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">eof</span></code> + indicates that the connection was closed by the peer. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h3"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.remarks">Remarks</a> + </h6> +<p> + The write_some operation may not transmit all of the data to the peer. + Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput"><span class="identifier">write</span></code></a> function if you need to + ensure that all data is written before the blocking operation completes. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.h4"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload1.example">Example</a> + </h6> +<p> + To write a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows: + </p> +<pre class="programlisting"><span class="identifier">handle</span><span class="special">.</span><span class="identifier">write_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">));</span> +</pre> +<p> + See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../write_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/windows__basic_stream_handle/write_some/overload2.html b/doc/html/boost_asio/reference/windows__basic_stream_handle/write_some/overload2.html new file mode 100644 index 0000000000..57e03adc60 --- /dev/null +++ b/doc/html/boost_asio/reference/windows__basic_stream_handle/write_some/overload2.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>windows::basic_stream_handle::write_some (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../write_some.html" title="windows::basic_stream_handle::write_some"> +<link rel="prev" href="overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)"> +<link rel="next" href="../../windows__object_handle.html" title="windows::object_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.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__object_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_stream_handle.write_some.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::write_some (2 of 2 overloads)">windows::basic_stream_handle::write_some + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Write some data to the handle. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">write_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</pre> +<p> + This function is used to write data to the stream handle. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more data buffers to be written to the handle. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of bytes written. Returns 0 if an error occurred. + </p> +<h6> +<a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload2.remarks">Remarks</a> + </h6> +<p> + The write_some operation may not transmit all of the data to the peer. + Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput"><span class="identifier">write</span></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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../windows__object_handle.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |