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