libs/beast/doc/html/beast/ref/boost__beast__http__async_write_some.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::async_write_some</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="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="boost__beast__http__async_write_header.html" title="http::async_write_header">
  10 <link rel="next" href="boost__beast__http__basic_chunk_extensions.html" title="http::basic_chunk_extensions">
  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="boost__beast__http__async_write_header.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__http__basic_chunk_extensions.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="beast.ref.boost__beast__http__async_write_some"></a><a class="link" href="boost__beast__http__async_write_some.html" title="http::async_write_some">http::async_write_some</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873506180160"></a>
  31 Write part of a message to a stream asynchronously
  32         using a serializer.
  33       </p>
  34 <h5>
  35 <a name="beast.ref.boost__beast__http__async_write_some.h0"></a>
  36         <span class="phrase"><a name="beast.ref.boost__beast__http__async_write_some.synopsis"></a></span><a class="link" href="boost__beast__http__async_write_some.html#beast.ref.boost__beast__http__async_write_some.synopsis">Synopsis</a>
  37       </h5>
  38 <p>
  39         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/http/write.hpp" target="_top">boost/beast/http/write.hpp</a>&gt;</code>
  40       </p>
  41 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  42     <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>
  43     <span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">,</span>
  44     <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>
  45     <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>
  46     <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>
  47 <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>
  48 <span class="identifier">async_write_some</span><span class="special">(</span>
  49     <span class="identifier">AsyncWriteStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">,</span>
  50     <span class="identifier">serializer</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">sr</span><span class="special">,</span>
  51     <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>
  52 </pre>
  53 <h5>
  54 <a name="beast.ref.boost__beast__http__async_write_some.h1"></a>
  55         <span class="phrase"><a name="beast.ref.boost__beast__http__async_write_some.description"></a></span><a class="link" href="boost__beast__http__async_write_some.html#beast.ref.boost__beast__http__async_write_some.description">Description</a>
  56       </h5>
  57 <p>
  58         This function is used to write part of a message to a stream asynchronously
  59         using a caller-provided HTTP/1 serializer. The function call always returns
  60         immediately. The asynchronous operation will continue until one of the following
  61         conditions is true:
  62       </p>
  63 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  64 <li class="listitem">
  65             One or more bytes have been transferred.
  66           </li>
  67 <li class="listitem">
  68             The function <a class="link" href="boost__beast__http__serializer/is_done.html" title="http::serializer::is_done"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">is_done</span></code></a> returns <code class="computeroutput"><span class="keyword">true</span></code>
  69           </li>
  70 <li class="listitem">
  71             An error occurs on the stream.
  72           </li>
  73 </ul></div>
  74 <p>
  75         This operation is implemented in terms of zero or more calls to the stream's
  76         <code class="computeroutput"><span class="identifier">async_write_some</span></code> function,
  77         and is known as a <span class="emphasis"><em>composed operation</em></span>. The program must
  78         ensure that the stream performs no other writes until this operation completes.
  79         The amount of data actually transferred is controlled by the behavior of
  80         the underlying stream, subject to the buffer size limit of the serializer
  81         obtained or set through a call to <a class="link" href="boost__beast__http__serializer/limit.html" title="http::serializer::limit"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">limit</span></code></a>. Setting a limit and performing
  82         bounded work helps applications set reasonable timeouts. It also allows application-level
  83         flow control to function correctly. For example when using a TCP/IP based
  84         stream.
  85       </p>
  86 <h5>
  87 <a name="beast.ref.boost__beast__http__async_write_some.h2"></a>
  88         <span class="phrase"><a name="beast.ref.boost__beast__http__async_write_some.parameters"></a></span><a class="link" href="boost__beast__http__async_write_some.html#beast.ref.boost__beast__http__async_write_some.parameters">Parameters</a>
  89       </h5>
  90 <div class="informaltable"><table class="table">
  91 <colgroup>
  92 <col>
  93 <col>
  94 </colgroup>
  95 <thead><tr>
  96 <th>
  97                 <p>
  98                   Name
  99                 </p>
 100               </th>
 101 <th>
 102                 <p>
 103                   Description
 104                 </p>
 105               </th>
 106 </tr></thead>
 107 <tbody>
 108 <tr>
 109 <td>
 110                 <p>
 111                   <code class="computeroutput"><span class="identifier">stream</span></code>
 112                 </p>
 113               </td>
 114 <td>
 115                 <p>
 116                   The stream to which the data is to be written. The type must support
 117                   the <span class="emphasis"><em>AsyncWriteStream</em></span> concept.
 118                 </p>
 119               </td>
 120 </tr>
 121 <tr>
 122 <td>
 123                 <p>
 124                   <code class="computeroutput"><span class="identifier">sr</span></code>
 125                 </p>
 126               </td>
 127 <td>
 128                 <p>
 129                   The serializer to use. The object must remain valid at least until
 130                   the handler is called; ownership is not transferred.
 131                 </p>
 132               </td>
 133 </tr>
 134 <tr>
 135 <td>
 136                 <p>
 137                   <code class="computeroutput"><span class="identifier">handler</span></code>
 138                 </p>
 139               </td>
 140 <td>
 141                 <p>
 142                   The completion handler to invoke when the operation completes.
 143                   The implementation takes ownership of the handler by performing
 144                   a decay-copy. The equivalent function signature of the handler
 145                   must be:
 146                 </p>
 147 <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>
 148     <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>
 149     <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>
 150 <span class="special">);</span>
 151 </pre>
 152                 <p>
 153                   Regardless of whether the asynchronous operation completes immediately
 154                   or not, the handler will not be invoked from within this function.
 155                   Invocation of the handler will be performed in a manner equivalent
 156                   to using <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code>.
 157                 </p>
 158               </td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 <h5>
 163 <a name="beast.ref.boost__beast__http__async_write_some.h3"></a>
 164         <span class="phrase"><a name="beast.ref.boost__beast__http__async_write_some.see_also"></a></span><a class="link" href="boost__beast__http__async_write_some.html#beast.ref.boost__beast__http__async_write_some.see_also">See Also</a>
 165       </h5>
 166 <p>
 167         <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>
 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="boost__beast__http__async_write_header.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__http__basic_chunk_extensions.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 185 </div>
 186 </body>
 187 </html>