doc/html/boost_asio/reference/async_write/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>async_write (1 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="../async_write.html" title="async_write">
  10 <link rel="next" href="overload2.html" title="async_write (2 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="../async_write.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="overload2.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.overload1"></a><a class="link" href="overload1.html" title="async_write (1 of 4 overloads)">async_write
  28         (1 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> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><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="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</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 buffers has been written. That is,
  52               the bytes transferred is equal to the sum of the buffer sizes.
  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.overload1.h0"></a>
  67           <span class="phrase"><a name="boost_asio.reference.async_write.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.async_write.overload1.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">buffers</span></dt>
  78 <dd><p>
  79                 One or more buffers containing the data to be written. Although the
  80                 buffers object may be copied as necessary, ownership of the underlying
  81                 memory blocks is retained by the caller, which must guarantee that
  82                 they remain valid 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"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
  92   <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>
  93
  94   <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>
  95                                           <span class="comment">// buffers. If an error occurred,</span>
  96                                           <span class="comment">// this will be less than the sum</span>
  97                                           <span class="comment">// of the buffer sizes.</span>
  98 <span class="special">);</span>
  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                 Invocation of the handler will be performed in a manner equivalent
 104                 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>.
 105               </p>
 106 </dd>
 107 </dl>
 108 </div>
 109 <h6>
 110 <a name="boost_asio.reference.async_write.overload1.h1"></a>
 111           <span class="phrase"><a name="boost_asio.reference.async_write.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.async_write.overload1.example">Example</a>
 112         </h6>
 113 <p>
 114           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:
 115         </p>
 116 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">async_write</span><span class="special">(</span><span class="identifier">s</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>
 117 </pre>
 118 <p>
 119           See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a>
 120           documentation for information on writing multiple buffers in one go, and
 121           how to use it with arrays, boost::array or std::vector.
 122         </p>
 123 </div>
 124 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 125 <td align="left"></td>
 126 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 127         Distributed under the Boost Software License, Version 1.0. (See accompanying
 128         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>)
 129       </p>
 130 </div></td>
 131 </tr></table>
 132 <hr>
 133 <div class="spirit-nav">
 134 <a accesskey="p" href="../async_write.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="overload2.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 135 </div>
 136 </body>
 137 </html>