libs/beast/doc/html/beast/ref/boost__beast__websocket__stream/async_write.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>websocket::stream::async_write</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__websocket__stream.html" title="websocket::stream">
   9 <link rel="prev" href="async_read_some/overload2.html" title="websocket::stream::async_read_some (2 of 2 overloads)">
  10 <link rel="next" href="async_write_some.html" title="websocket::stream::async_write_some">
  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_read_some/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__websocket__stream.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="async_write_some.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__websocket__stream.async_write"></a><a class="link" href="async_write.html" title="websocket::stream::async_write">websocket::stream::async_write</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873472435360"></a>
  31 Write a complete message asynchronously.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__websocket__stream.async_write.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.async_write.synopsis"></a></span><a class="link" href="async_write.html#beast.ref.boost__beast__websocket__stream.async_write.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  38     <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/ConstBufferSequence.html" target="_top"><span class="emphasis"><em>ConstBufferSequence</em></span></a><span class="special">,</span>
  39     <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">&gt;&gt;</span>
  40 <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>
  41 <span class="identifier">async_write</span><span class="special">(</span>
  42     <span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  43     <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">&gt;{});</span>
  44 </pre>
  45 <h6>
  46 <a name="beast.ref.boost__beast__websocket__stream.async_write.h1"></a>
  47           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.async_write.description"></a></span><a class="link" href="async_write.html#beast.ref.boost__beast__websocket__stream.async_write.description">Description</a>
  48         </h6>
  49 <p>
  50           This function is used to asynchronously write a complete message. This
  51           call always returns immediately. The asynchronous operation will continue
  52           until one of the following conditions is true:
  53         </p>
  54 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  55 <li class="listitem">
  56               The complete message is written.
  57             </li>
  58 <li class="listitem">
  59               An error occurs.
  60             </li>
  61 </ul></div>
  62 <p>
  63           The algorithm, known as a <span class="emphasis"><em>composed asynchronous operation</em></span>,
  64           is implemented in terms of calls to the next layer's <code class="computeroutput"><span class="identifier">async_write_some</span></code>
  65           function. The program must ensure that no other calls to <a class="link" href="write.html" title="websocket::stream::write"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">write</span></code></a>, <a class="link" href="write_some.html" title="websocket::stream::write_some"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">write_some</span></code></a>, <a class="link" href="async_write.html" title="websocket::stream::async_write"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">async_write</span></code></a>, or <a class="link" href="async_write_some.html" title="websocket::stream::async_write_some"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">async_write_some</span></code></a> are performed
  66           until this operation completes. The current setting of the <a class="link" href="binary.html" title="websocket::stream::binary"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">binary</span></code></a> option controls whether
  67           the message opcode is set to text or binary. If the <a class="link" href="auto_fragment.html" title="websocket::stream::auto_fragment"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">auto_fragment</span></code></a> option is set, the
  68           message will be split into one or more frames as necessary. The actual
  69           payload contents sent may be transformed as per the WebSocket protocol
  70           settings.
  71         </p>
  72 <h6>
  73 <a name="beast.ref.boost__beast__websocket__stream.async_write.h2"></a>
  74           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.async_write.parameters"></a></span><a class="link" href="async_write.html#beast.ref.boost__beast__websocket__stream.async_write.parameters">Parameters</a>
  75         </h6>
  76 <div class="informaltable"><table class="table">
  77 <colgroup>
  78 <col>
  79 <col>
  80 </colgroup>
  81 <thead><tr>
  82 <th>
  83                   <p>
  84                     Name
  85                   </p>
  86                 </th>
  87 <th>
  88                   <p>
  89                     Description
  90                   </p>
  91                 </th>
  92 </tr></thead>
  93 <tbody>
  94 <tr>
  95 <td>
  96                   <p>
  97                     <code class="computeroutput"><span class="identifier">buffers</span></code>
  98                   </p>
  99                 </td>
 100 <td>
 101                   <p>
 102                     A buffer sequence containing the entire message payload. The
 103                     implementation will make copies of this object as needed, but
 104                     ownership of the underlying memory is not transferred. The caller
 105                     is responsible for ensuring that the memory locations pointed
 106                     to by buffers remains valid until the completion handler is called.
 107                   </p>
 108                 </td>
 109 </tr>
 110 <tr>
 111 <td>
 112                   <p>
 113                     <code class="computeroutput"><span class="identifier">handler</span></code>
 114                   </p>
 115                 </td>
 116 <td>
 117                   <p>
 118                     The completion handler to invoke when the operation completes.
 119                     The implementation takes ownership of the handler by performing
 120                     a decay-copy. The equivalent function signature of the handler
 121                     must be:
 122                   </p>
 123 <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>
 124     <span class="identifier">error_code</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>           <span class="comment">// Result of operation</span>
 125     <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 sent from the</span>
 126                                     <span class="comment">// buffers. If an error occurred,</span>
 127                                     <span class="comment">// this will be less than the buffer_size.</span>
 128 <span class="special">);</span>
 129 </pre>
 130                   <p>
 131                     Regardless of whether the asynchronous operation completes immediately
 132                     or not, the handler will not be invoked from within this function.
 133                     Invocation of the handler will be performed in a manner equivalent
 134                     to using <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code>.
 135                   </p>
 136                 </td>
 137 </tr>
 138 </tbody>
 139 </table></div>
 140 </div>
 141 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 142 <td align="left"></td>
 143 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 144       Falco<p>
 145         Distributed under the Boost Software License, Version 1.0. (See accompanying
 146         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>)
 147       </p>
 148 </div></td>
 149 </tr></table>
 150 <hr>
 151 <div class="spirit-nav">
 152 <a accesskey="p" href="async_read_some/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__websocket__stream.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="async_write_some.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 153 </div>
 154 </body>
 155 </html>