diff options
Diffstat (limited to 'doc/html/boost_asio/reference/async_write/overload7.html')
| -rw-r--r-- | doc/html/boost_asio/reference/async_write/overload7.html | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/async_write/overload7.html b/doc/html/boost_asio/reference/async_write/overload7.html new file mode 100644 index 0000000000..75d70f8bad --- /dev/null +++ b/doc/html/boost_asio/reference/async_write/overload7.html @@ -0,0 +1,124 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>async_write (7 of 8 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="../async_write.html" title="async_write"> +<link rel="prev" href="overload6.html" title="async_write (6 of 8 overloads)"> +<link rel="next" href="overload8.html" title="async_write (8 of 8 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="overload6.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_write.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="overload8.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.async_write.overload7"></a><a class="link" href="overload7.html" title="async_write (7 of 8 overloads)">async_write + (7 of 8 overloads)</a> +</h4></div></div></div> +<p> + Start an asynchronous operation to write all of the supplied data to a + stream. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../AsyncWriteStream.html" title="Buffer-oriented asynchronous write stream requirements">AsyncWriteStream</a>, + typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>, + typename <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a>> +<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_write( + AsyncWriteStream & s, + DynamicBuffer_v2 buffers, + WriteHandler && handler, + typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0); +</pre> +<p> + This function is used to asynchronously write a certain number of bytes + of data to a stream. The function call always returns immediately. The + asynchronous operation will continue until one of the following conditions + is true: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"> + All of the data in the supplied dynamic buffer sequence has been written. + </li> +<li class="listitem"> + An error occurred. + </li> +</ul></div> +<p> + This operation is implemented in terms of zero or more calls to the stream's + async_write_some function, and is known as a <span class="emphasis"><em>composed operation</em></span>. + The program must ensure that the stream performs no other write operations + (such as async_write, the stream's async_write_some function, or any other + composed operations that perform writes) until this operation completes. + </p> +<h6> +<a name="boost_asio.reference.async_write.overload7.h0"></a> + <span class="phrase"><a name="boost_asio.reference.async_write.overload7.parameters"></a></span><a class="link" href="overload7.html#boost_asio.reference.async_write.overload7.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">s</span></dt> +<dd><p> + The stream to which the data is to be written. The type must support + the AsyncWriteStream concept. + </p></dd> +<dt><span class="term">buffers</span></dt> +<dd><p> + The dynamic buffer sequence from which data will be written. 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. Successfully written + data is automatically consumed from the buffers. + </p></dd> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called when the write operation completes. Copies + will be made of the handler as required. The function signature of + the handler must be: +</p> +<pre class="programlisting">void handler( + const boost::system::error_code& error, // Result of operation. + + std::size_t bytes_transferred // Number of bytes written from the + // buffers. If an error occurred, + // this will be less than the sum + // of the buffer sizes. +); +</pre> +<p> + Regardless of whether the asynchronous operation completes immediately + or not, the handler will not be invoked from within this function. + On immediate completion, invocation of the handler will be performed + in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>. + </p> +</dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2019 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload6.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_write.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="overload8.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |