• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>websocket::stream::auto_fragment (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="../auto_fragment.html" title="websocket::stream::auto_fragment">
9<link rel="prev" href="../auto_fragment.html" title="websocket::stream::auto_fragment">
10<link rel="next" href="overload2.html" title="websocket::stream::auto_fragment (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="../auto_fragment.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../auto_fragment.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.auto_fragment.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::auto_fragment (1 of 2 overloads)">websocket::stream::auto_fragment
28          (1 of 2 overloads)</a>
29</h6></div></div></div>
30<p>
31            Set the automatic fragmentation option.
32          </p>
33<h7><a name="beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.h0"></a>
34            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.synopsis">Synopsis</a>
35          </h7><pre class="programlisting"><span class="keyword">void</span>
36<span class="identifier">auto_fragment</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.auto_fragment.overload1.h1"></a>
40            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.description">Description</a>
41          </h7><p>
42            Determines if outgoing message payloads are broken up into multiple pieces.
43            When the automatic fragmentation size is turned on, outgoing message
44            payloads are broken up into multiple frames no larger than the write
45            buffer size. The default setting is to fragment messages.
46          </p>
47<h7><a name="beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.h2"></a>
48            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.parameters">Parameters</a>
49          </h7><div class="informaltable"><table class="table">
50<colgroup>
51<col>
52<col>
53</colgroup>
54<thead><tr>
55<th>
56                    <p>
57                      Name
58                    </p>
59                  </th>
60<th>
61                    <p>
62                      Description
63                    </p>
64                  </th>
65</tr></thead>
66<tbody><tr>
67<td>
68                    <p>
69                      <code class="computeroutput"><span class="identifier">value</span></code>
70                    </p>
71                  </td>
72<td>
73                    <p>
74                      A <code class="computeroutput"><span class="keyword">bool</span></code> indicating
75                      if auto fragmentation should be on.
76                    </p>
77                  </td>
78</tr></tbody>
79</table></div>
80<h7><a name="beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.h3"></a>
81            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.example"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.auto_fragment.overload1.example">Example</a>
82          </h7><p>
83            Setting the automatic fragmentation option:
84          </p>
85<pre class="programlisting"><span class="identifier">ws</span><span class="special">.</span><span class="identifier">auto_fragment</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span>
86</pre>
87</div>
88<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
89<td align="left"></td>
90<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
91      Falco<p>
92        Distributed under the Boost Software License, Version 1.0. (See accompanying
93        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>)
94      </p>
95</div></td>
96</tr></table>
97<hr>
98<div class="spirit-nav">
99<a accesskey="p" href="../auto_fragment.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../auto_fragment.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>
100</div>
101</body>
102</html>
103