libs/beast/doc/html/beast/ref/boost__beast__http__async_write/overload2.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::async_write (2 of 3 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="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../boost__beast__http__async_write.html" title="http::async_write">
   9 <link rel="prev" href="overload1.html" title="http::async_write (1 of 3 overloads)">
  10 <link rel="next" href="overload3.html" title="http::async_write (3 of 3 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="overload1.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__async_write.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.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>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="beast.ref.boost__beast__http__async_write.overload2"></a><a class="link" href="overload2.html" title="http::async_write (2 of 3 overloads)">http::async_write
  28         (2 of 3 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31           Write a complete message to a stream asynchronously.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__http__async_write.overload2.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__async_write.overload2.synopsis">Synopsis</a>
  36         </h6>
  37 <p>
  38           Defined in header <code class="literal">&lt;<a href="../../../../../../../boost/beast/http/write.hpp" target="_top">boost/beast/http/write.hpp</a>&gt;</code>
  39         </p>
  40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  41     <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/AsyncWriteStream.html" target="_top"><span class="emphasis"><em>AsyncWriteStream</em></span></a><span class="special">,</span>
  42     <span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">,</span>
  43     <span class="keyword">class</span> <a class="link" href="../../concepts/Body.html" title="Body"><span class="emphasis"><em>Body</em></span></a><span class="special">,</span>
  44     <span class="keyword">class</span> <a class="link" href="../../concepts/Fields.html" title="Fields"><span class="emphasis"><em>Fields</em></span></a><span class="special">,</span>
  45     <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/WriteHandler.html" target="_top"><span class="emphasis"><em>WriteHandler</em></span></a> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span>            <span class="identifier">executor_type</span><span class="special">&lt;</span><span class="identifier">AsyncWriteStream</span><span class="special">&gt;&gt;&gt;</span>
  46 <a href="../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a>
  47 <span class="identifier">async_write</span><span class="special">(</span>
  48     <span class="identifier">AsyncWriteStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">,</span>
  49     <span class="identifier">message</span><span class="special">&lt;</span> <span class="identifier">isRequest</span><span class="special">,</span> <span class="identifier">Body</span><span class="special">,</span> <span class="identifier">Fields</span> <span class="special">&gt;&amp;</span> <span class="identifier">msg</span><span class="special">,</span>
  50     <span class="identifier">WriteHandler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span> <span class="identifier">executor_type</span><span class="special">&lt;</span> <span class="identifier">AsyncWriteStream</span> <span class="special">&gt;&gt;{});</span>
  51 </pre>
  52 <h6>
  53 <a name="beast.ref.boost__beast__http__async_write.overload2.h1"></a>
  54           <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__async_write.overload2.description">Description</a>
  55         </h6>
  56 <p>
  57           This function is used to write a complete message to a stream asynchronously
  58           using HTTP/1. The function call always returns immediately. The asynchronous
  59           operation will continue until one of the following conditions is true:
  60         </p>
  61 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  62 <li class="listitem">
  63               The entire message is written.
  64             </li>
  65 <li class="listitem">
  66               An error occurs.
  67             </li>
  68 </ul></div>
  69 <p>
  70           This operation is implemented in terms of zero or more calls to the stream's
  71           <code class="computeroutput"><span class="identifier">async_write_some</span></code> function,
  72           and is known as a <span class="emphasis"><em>composed operation</em></span>. The program
  73           must ensure that the stream performs no other writes until this operation
  74           completes. The algorithm will use a temporary <a class="link" href="../boost__beast__http__serializer.html" title="http::serializer"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span></code></a> with an empty chunk
  75           decorator to produce buffers.
  76         </p>
  77 <h6>
  78 <a name="beast.ref.boost__beast__http__async_write.overload2.h2"></a>
  79           <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload2.remarks"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__async_write.overload2.remarks">Remarks</a>
  80         </h6>
  81 <p>
  82           This function only participates in overload resolution if <a class="link" href="../boost__beast__http__is_mutable_body_writer.html" title="http::is_mutable_body_writer"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">is_mutable_body_writer</span></code></a> for <span class="emphasis"><em>Body</em></span>
  83           returns <code class="computeroutput"><span class="keyword">true</span></code>.
  84         </p>
  85 <h6>
  86 <a name="beast.ref.boost__beast__http__async_write.overload2.h3"></a>
  87           <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__async_write.overload2.parameters">Parameters</a>
  88         </h6>
  89 <div class="informaltable"><table class="table">
  90 <colgroup>
  91 <col>
  92 <col>
  93 </colgroup>
  94 <thead><tr>
  95 <th>
  96                   <p>
  97                     Name
  98                   </p>
  99                 </th>
 100 <th>
 101                   <p>
 102                     Description
 103                   </p>
 104                 </th>
 105 </tr></thead>
 106 <tbody>
 107 <tr>
 108 <td>
 109                   <p>
 110                     <code class="computeroutput"><span class="identifier">stream</span></code>
 111                   </p>
 112                 </td>
 113 <td>
 114                   <p>
 115                     The stream to which the data is to be written. The type must
 116                     support the <span class="emphasis"><em>AsyncWriteStream</em></span> concept.
 117                   </p>
 118                 </td>
 119 </tr>
 120 <tr>
 121 <td>
 122                   <p>
 123                     <code class="computeroutput"><span class="identifier">msg</span></code>
 124                   </p>
 125                 </td>
 126 <td>
 127                   <p>
 128                     The message to write. The object must remain valid at least until
 129                     the handler is called; ownership is not transferred.
 130                   </p>
 131                 </td>
 132 </tr>
 133 <tr>
 134 <td>
 135                   <p>
 136                     <code class="computeroutput"><span class="identifier">handler</span></code>
 137                   </p>
 138                 </td>
 139 <td>
 140                   <p>
 141                     The completion handler to invoke when the operation completes.
 142                     The implementation takes ownership of the handler by performing
 143                     a decay-copy. The equivalent function signature of the handler
 144                     must be:
 145                   </p>
 146 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
 147     <span class="identifier">error_code</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">error</span><span class="special">,</span>        <span class="comment">// result of operation</span>
 148     <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span>   <span class="comment">// the number of bytes written to the stream</span>
 149 <span class="special">);</span>
 150 </pre>
 151                   <p>
 152                     Regardless of whether the asynchronous operation completes immediately
 153                     or not, the handler will not be invoked from within this function.
 154                     Invocation of the handler will be performed in a manner equivalent
 155                     to using <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code>.
 156                   </p>
 157                 </td>
 158 </tr>
 159 </tbody>
 160 </table></div>
 161 <h6>
 162 <a name="beast.ref.boost__beast__http__async_write.overload2.h4"></a>
 163           <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload2.see_also"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__async_write.overload2.see_also">See
 164           Also</a>
 165         </h6>
 166 <p>
 167           <a class="link" href="../boost__beast__http__message.html" title="http::message"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">message</span></code></a>
 168         </p>
 169 <p>
 170           Convenience header <code class="literal">&lt;<a href="../../../../../../../boost/beast/http.hpp" target="_top">boost/beast/http.hpp</a>&gt;</code>
 171         </p>
 172 </div>
 173 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 174 <td align="left"></td>
 175 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 176       Falco<p>
 177         Distributed under the Boost Software License, Version 1.0. (See accompanying
 178         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>)
 179       </p>
 180 </div></td>
 181 </tr></table>
 182 <hr>
 183 <div class="spirit-nav">
 184 <a accesskey="p" href="overload1.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__async_write.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.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>
 185 </div>
 186 </body>
 187 </html>