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