doc/html/boost_asio/reference/async_write/overload5.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>async_write (5 of 8 overloads)</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../async_write.html" title="async_write">
   9 <link rel="prev" href="overload4.html" title="async_write (4 of 8 overloads)">
  10 <link rel="next" href="overload6.html" title="async_write (6 of 8 overloads)">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="overload4.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="overload6.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.async_write.overload5"></a><a class="link" href="overload5.html" title="async_write (5 of 8 overloads)">async_write
  28         (5 of 8 overloads)</a>
  29 </h4></div></div></div>
  30 <p>
  31           Start an asynchronous operation to write all of the supplied data to a
  32           stream.
  33         </p>
  34 <pre class="programlisting">template&lt;
  35     typename <a class="link" href="../AsyncWriteStream.html" title="Buffer-oriented asynchronous write stream requirements">AsyncWriteStream</a>,
  36     typename Allocator,
  37     typename <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a> = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
  38 <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(
  39     AsyncWriteStream &amp; s,
  40     basic_streambuf&lt; Allocator &gt; &amp; b,
  41     WriteHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
  42 </pre>
  43 <p>
  44           This function is used to asynchronously write a certain number of bytes
  45           of data to a stream. The function call always returns immediately. The
  46           asynchronous operation will continue until one of the following conditions
  47           is true:
  48         </p>
  49 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  50 <li class="listitem">
  51               All of the data in the supplied <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput">basic_streambuf</code></a>
  52               has been written.
  53             </li>
  54 <li class="listitem">
  55               An error occurred.
  56             </li>
  57 </ul></div>
  58 <p>
  59           This operation is implemented in terms of zero or more calls to the stream's
  60           async_write_some function, and is known as a <span class="emphasis"><em>composed operation</em></span>.
  61           The program must ensure that the stream performs no other write operations
  62           (such as async_write, the stream's async_write_some function, or any other
  63           composed operations that perform writes) until this operation completes.
  64         </p>
  65 <h6>
  66 <a name="boost_asio.reference.async_write.overload5.h0"></a>
  67           <span class="phrase"><a name="boost_asio.reference.async_write.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.async_write.overload5.parameters">Parameters</a>
  68         </h6>
  69 <div class="variablelist">
  70 <p class="title"><b></b></p>
  71 <dl class="variablelist">
  72 <dt><span class="term">s</span></dt>
  73 <dd><p>
  74                 The stream to which the data is to be written. The type must support
  75                 the AsyncWriteStream concept.
  76               </p></dd>
  77 <dt><span class="term">b</span></dt>
  78 <dd><p>
  79                 A <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput">basic_streambuf</code></a>
  80                 object from which data will be written. Ownership of the streambuf
  81                 is retained by the caller, which must guarantee that it remains valid
  82                 until the handler is called.
  83               </p></dd>
  84 <dt><span class="term">handler</span></dt>
  85 <dd>
  86 <p>
  87                 The handler to be called when the write operation completes. Copies
  88                 will be made of the handler as required. The function signature of
  89                 the handler must be:
  90 </p>
  91 <pre class="programlisting">void handler(
  92   const boost::system::error_code&amp; error, // Result of operation.
  93
  94   std::size_t bytes_transferred           // Number of bytes written from the
  95                                           // buffers. If an error occurred,
  96                                           // this will be less than the sum
  97                                           // of the buffer sizes.
  98 );
  99 </pre>
 100 <p>
 101                 Regardless of whether the asynchronous operation completes immediately
 102                 or not, the handler will not be invoked from within this function.
 103                 On immediate completion, invocation of the handler will be performed
 104                 in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>.
 105               </p>
 106 </dd>
 107 </dl>
 108 </div>
 109 </div>
 110 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 111 <td align="left"></td>
 112 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 113         Distributed under the Boost Software License, Version 1.0. (See accompanying
 114         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>)
 115       </p>
 116 </div></td>
 117 </tr></table>
 118 <hr>
 119 <div class="spirit-nav">
 120 <a accesskey="p" href="overload4.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="overload6.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 121 </div>
 122 </body>
 123 </html>