1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::binary (1 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="../binary.html" title="websocket::stream::binary"> 9<link rel="prev" href="../binary.html" title="websocket::stream::binary"> 10<link rel="next" href="overload2.html" title="websocket::stream::binary (2 of 2 overloads)"> 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="../binary.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../binary.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="overload2.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.binary.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::binary (1 of 2 overloads)">websocket::stream::binary 28 (1 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Set the binary message write option. 32 </p> 33<h7><a name="beast.ref.boost__beast__websocket__stream.binary.overload1.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.binary.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.binary.overload1.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">void</span> 36<span class="identifier">binary</span><span class="special">(</span> 37 <span class="keyword">bool</span> <span class="identifier">value</span><span class="special">);</span> 38</pre> 39<h7><a name="beast.ref.boost__beast__websocket__stream.binary.overload1.h1"></a> 40 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.binary.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.binary.overload1.description">Description</a> 41 </h7><p> 42 This controls whether or not outgoing message opcodes are set to binary 43 or text. The setting is only applied at the start when a caller begins 44 a new message. Changing the opcode after a message is started will only 45 take effect after the current message being sent is complete. The default 46 setting is to send text messages. 47 </p> 48<h7><a name="beast.ref.boost__beast__websocket__stream.binary.overload1.h2"></a> 49 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.binary.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.binary.overload1.parameters">Parameters</a> 50 </h7><div class="informaltable"><table class="table"> 51<colgroup> 52<col> 53<col> 54</colgroup> 55<thead><tr> 56<th> 57 <p> 58 Name 59 </p> 60 </th> 61<th> 62 <p> 63 Description 64 </p> 65 </th> 66</tr></thead> 67<tbody><tr> 68<td> 69 <p> 70 <code class="computeroutput"><span class="identifier">value</span></code> 71 </p> 72 </td> 73<td> 74 <p> 75 <code class="computeroutput"><span class="keyword">true</span></code> if outgoing 76 messages should indicate binary, or <code class="computeroutput"><span class="keyword">false</span></code> 77 if they should indicate text. 78 </p> 79 </td> 80</tr></tbody> 81</table></div> 82<h7><a name="beast.ref.boost__beast__websocket__stream.binary.overload1.h3"></a> 83 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.binary.overload1.example"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.binary.overload1.example">Example</a> 84 </h7><p> 85 Setting the message type to binary. 86 </p> 87<pre class="programlisting"><span class="identifier">ws</span><span class="special">.</span><span class="identifier">binary</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> 88</pre> 89</div> 90<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 91<td align="left"></td> 92<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 93 Falco<p> 94 Distributed under the Boost Software License, Version 1.0. (See accompanying 95 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>) 96 </p> 97</div></td> 98</tr></table> 99<hr> 100<div class="spirit-nav"> 101<a accesskey="p" href="../binary.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../binary.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="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 102</div> 103</body> 104</html> 105
