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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>websocket::stream::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="../boost__beast__websocket__stream.html" title="websocket::stream">
   9 <link rel="prev" href="async_write.html" title="websocket::stream::async_write">
  10 <link rel="next" href="auto_fragment.html" title="websocket::stream::auto_fragment">
  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="../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="auto_fragment.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_some"></a><a class="link" href="async_write_some.html" title="websocket::stream::async_write_some">websocket::stream::async_write_some</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873472346944"></a>
  31 Write some message data asynchronously.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__websocket__stream.async_write_some.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.async_write_some.synopsis"></a></span><a class="link" href="async_write_some.html#beast.ref.boost__beast__websocket__stream.async_write_some.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_some</span><span class="special">(</span>
  42     <span class="keyword">bool</span> <span class="identifier">fin</span><span class="special">,</span>
  43     <span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  44     <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>
  45 </pre>
  46 <h6>
  47 <a name="beast.ref.boost__beast__websocket__stream.async_write_some.h1"></a>
  48           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.async_write_some.description"></a></span><a class="link" href="async_write_some.html#beast.ref.boost__beast__websocket__stream.async_write_some.description">Description</a>
  49         </h6>
  50 <p>
  51           This function is used to asynchronously write part of a message. This call
  52           always returns immediately. The asynchronous operation will continue until
  53           one of the following conditions is true:
  54         </p>
  55 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  56 <li class="listitem">
  57               The message data is written.
  58             </li>
  59 <li class="listitem">
  60               An error occurs.
  61             </li>
  62 </ul></div>
  63 <p>
  64           The algorithm, known as a <span class="emphasis"><em>composed asynchronous operation</em></span>,
  65           is implemented in terms of calls to the next layer's <code class="computeroutput"><span class="identifier">async_write_some</span></code>
  66           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
  67           until this operation completes. If this is the beginning of a new message,
  68           the message opcode will be set to text or binary based on the current setting
  69           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> (or <a class="link" href="text.html" title="websocket::stream::text"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">text</span></code></a>) option. The actual payload
  70           sent may be transformed as per the WebSocket protocol settings.
  71         </p>
  72 <h6>
  73 <a name="beast.ref.boost__beast__websocket__stream.async_write_some.h2"></a>
  74           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#beast.ref.boost__beast__websocket__stream.async_write_some.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">fin</span></code>
  98                   </p>
  99                 </td>
 100 <td>
 101                   <p>
 102                     <code class="computeroutput"><span class="keyword">true</span></code> if this is
 103                     the last part of the message.
 104                   </p>
 105                 </td>
 106 </tr>
 107 <tr>
 108 <td>
 109                   <p>
 110                     <code class="computeroutput"><span class="identifier">buffers</span></code>
 111                   </p>
 112                 </td>
 113 <td>
 114                   <p>
 115                     The buffers containing the message part to send. The implementation
 116                     will make copies of this object as needed, but ownership of the
 117                     underlying memory is not transferred. The caller is responsible
 118                     for ensuring that the memory locations pointed to by buffers
 119                     remains valid until the completion handler is called.
 120                   </p>
 121                 </td>
 122 </tr>
 123 <tr>
 124 <td>
 125                   <p>
 126                     <code class="computeroutput"><span class="identifier">handler</span></code>
 127                   </p>
 128                 </td>
 129 <td>
 130                   <p>
 131                     The completion handler to invoke when the operation completes.
 132                     The implementation takes ownership of the handler by performing
 133                     a decay-copy. The equivalent function signature of the handler
 134                     must be:
 135                   </p>
 136 <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>
 137     <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>
 138     <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>
 139                                     <span class="comment">// buffers. If an error occurred,</span>
 140                                     <span class="comment">// this will be less than the buffer_size.</span>
 141 <span class="special">);</span>
 142 </pre>
 143                   <p>
 144                     Regardless of whether the asynchronous operation completes immediately
 145                     or not, the handler will not be invoked from within this function.
 146                     Invocation of the handler will be performed in a manner equivalent
 147                     to using <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code>.
 148                   </p>
 149                 </td>
 150 </tr>
 151 </tbody>
 152 </table></div>
 153 </div>
 154 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 155 <td align="left"></td>
 156 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 157       Falco<p>
 158         Distributed under the Boost Software License, Version 1.0. (See accompanying
 159         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>)
 160       </p>
 161 </div></td>
 162 </tr></table>
 163 <hr>
 164 <div class="spirit-nav">
 165 <a accesskey="p" href="async_write.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="auto_fragment.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 166 </div>
 167 </body>
 168 </html>