1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::write_some (2 of 2 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 1. Boost.Beast"> 8<link rel="up" href="../write_some.html" title="websocket::stream::write_some"> 9<link rel="prev" href="overload1.html" title="websocket::stream::write_some (1 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="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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><h6 class="title"> 27<a name="beast.ref.boost__beast__websocket__stream.write_some.overload2"></a><a class="link" href="overload2.html" title="websocket::stream::write_some (2 of 2 overloads)">websocket::stream::write_some 28 (2 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Write some message data. 32 </p> 33<h7><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.write_some.overload2.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <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> 37<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> 38<span class="identifier">write_some</span><span class="special">(</span> 39 <span class="keyword">bool</span> <span class="identifier">fin</span><span class="special">,</span> 40 <span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> 41 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> 42</pre> 43<h7><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.h1"></a> 44 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.write_some.overload2.description">Description</a> 45 </h7><p> 46 This function is used to send part of a message. The call blocks until 47 one of the following is true: 48 </p> 49<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 50<li class="listitem"> 51 The message data is written. 52 </li> 53<li class="listitem"> 54 An error occurs. 55 </li> 56</ul></div> 57<p> 58 The algorithm, known as a <span class="emphasis"><em>composed operation</em></span>, is 59 implemented in terms of calls to the next layer's <code class="computeroutput"><span class="identifier">write_some</span></code> 60 function. If this is the beginning of a new message, the message opcode 61 will be set to text or binary based on the current setting 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 62 sent may be transformed as per the WebSocket protocol settings. 63 </p> 64<h7><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.h2"></a> 65 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.write_some.overload2.parameters">Parameters</a> 66 </h7><div class="informaltable"><table class="table"> 67<colgroup> 68<col> 69<col> 70</colgroup> 71<thead><tr> 72<th> 73 <p> 74 Name 75 </p> 76 </th> 77<th> 78 <p> 79 Description 80 </p> 81 </th> 82</tr></thead> 83<tbody> 84<tr> 85<td> 86 <p> 87 <code class="computeroutput"><span class="identifier">fin</span></code> 88 </p> 89 </td> 90<td> 91 <p> 92 <code class="computeroutput"><span class="keyword">true</span></code> if this is 93 the last part of the message. 94 </p> 95 </td> 96</tr> 97<tr> 98<td> 99 <p> 100 <code class="computeroutput"><span class="identifier">buffers</span></code> 101 </p> 102 </td> 103<td> 104 <p> 105 The buffers containing the message part to send. 106 </p> 107 </td> 108</tr> 109<tr> 110<td> 111 <p> 112 <code class="computeroutput"><span class="identifier">ec</span></code> 113 </p> 114 </td> 115<td> 116 <p> 117 Set to indicate what error occurred, if any. 118 </p> 119 </td> 120</tr> 121</tbody> 122</table></div> 123<h7><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.h3"></a> 124 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.return_value"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.write_some.overload2.return_value">Return 125 Value</a> 126 </h7><p> 127 The number of bytes sent from the buffers. 128 </p> 129<h7><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.h4"></a> 130 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_some.overload2.return_value0"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.write_some.overload2.return_value0">Return 131 Value</a> 132 </h7><p> 133 The number of bytes consumed in the input buffers. 134 </p> 135</div> 136<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 137<td align="left"></td> 138<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 139 Falco<p> 140 Distributed under the Boost Software License, Version 1.0. (See accompanying 141 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>) 142 </p> 143</div></td> 144</tr></table> 145<hr> 146<div class="spirit-nav"> 147<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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> 148</div> 149</body> 150</html> 151
