doc/html/boost_asio/reference/async_write/overload3.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>async_write (3 of 4 overloads)</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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="overload2.html" title="async_write (2 of 4 overloads)">
  10 <link rel="next" href="overload4.html" title="async_write (4 of 4 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="overload2.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="overload4.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.overload3"></a><a class="link" href="overload3.html" title="async_write (3 of 4 overloads)">async_write
  28         (3 of 4 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"><span class="keyword">template</span><span class="special">&lt;</span>
  35     <span class="keyword">typename</span> <a class="link" href="../AsyncWriteStream.html" title="Buffer-oriented asynchronous write stream requirements">AsyncWriteStream</a><span class="special">,</span>
  36     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
  37     <span class="keyword">typename</span> <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a><span class="special">&gt;</span>
  38 <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</span><span class="special">(</span>
  39     <span class="identifier">AsyncWriteStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  40     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">,</span>
  41     <span class="identifier">WriteHandler</span> <span class="identifier">handler</span><span class="special">);</span>
  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"><span class="identifier">basic_streambuf</span></code></a> has been written.
  52             </li>
  53 <li class="listitem">
  54               An error occurred.
  55             </li>
  56 </ul></div>
  57 <p>
  58           This operation is implemented in terms of zero or more calls to the stream's
  59           async_write_some function, and is known as a <span class="emphasis"><em>composed operation</em></span>.
  60           The program must ensure that the stream performs no other write operations
  61           (such as async_write, the stream's async_write_some function, or any other
  62           composed operations that perform writes) until this operation completes.
  63         </p>
  64 <h6>
  65 <a name="boost_asio.reference.async_write.overload3.h0"></a>
  66           <span class="phrase"><a name="boost_asio.reference.async_write.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.async_write.overload3.parameters">Parameters</a>
  67         </h6>
  68 <div class="variablelist">
  69 <p class="title"><b></b></p>
  70 <dl class="variablelist">
  71 <dt><span class="term">s</span></dt>
  72 <dd><p>
  73                 The stream to which the data is to be written. The type must support
  74                 the AsyncWriteStream concept.
  75               </p></dd>
  76 <dt><span class="term">b</span></dt>
  77 <dd><p>
  78                 A <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput"><span class="identifier">basic_streambuf</span></code></a> object from
  79                 which data will be written. Ownership of the streambuf is retained
  80                 by the caller, which must guarantee that it remains valid until the
  81                 handler is called.
  82               </p></dd>
  83 <dt><span class="term">handler</span></dt>
  84 <dd>
  85 <p>
  86                 The handler to be called when the write operation completes. Copies
  87                 will be made of the handler as required. The function signature of
  88                 the handler must be:
  89 </p>
  90 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
  91   <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">&amp;</span> <span class="identifier">error</span><span class="special">,</span> <span class="comment">// Result of operation.</span>
  92
  93   <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 from the</span>
  94                                           <span class="comment">// buffers. If an error occurred,</span>
  95                                           <span class="comment">// this will be less than the sum</span>
  96                                           <span class="comment">// of the buffer sizes.</span>
  97 <span class="special">);</span>
  98 </pre>
  99 <p>
 100                 Regardless of whether the asynchronous operation completes immediately
 101                 or not, the handler will not be invoked from within this function.
 102                 Invocation of the handler will be performed in a manner equivalent
 103                 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>.
 104               </p>
 105 </dd>
 106 </dl>
 107 </div>
 108 </div>
 109 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 110 <td align="left"></td>
 111 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 112         Distributed under the Boost Software License, Version 1.0. (See accompanying
 113         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>)
 114       </p>
 115 </div></td>
 116 </tr></table>
 117 <hr>
 118 <div class="spirit-nav">
 119 <a accesskey="p" href="overload2.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="overload4.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 120 </div>
 121 </body>
 122 </html>