• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>http::chunk_header::chunk_header (3 of 5 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="../chunk_header.html" title="http::chunk_header::chunk_header">
9<link rel="prev" href="overload2.html" title="http::chunk_header::chunk_header (2 of 5 overloads)">
10<link rel="next" href="overload4.html" title="http::chunk_header::chunk_header (4 of 5 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="overload2.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../chunk_header.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="overload4.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__http__chunk_header.chunk_header.overload3"></a><a class="link" href="overload3.html" title="http::chunk_header::chunk_header (3 of 5 overloads)">http::chunk_header::chunk_header
28          (3 of 5 overloads)</a>
29</h6></div></div></div>
30<p>
31            Constructor.
32          </p>
33<h7><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.h0"></a>
34            <span class="phrase"><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.synopsis"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.synopsis">Synopsis</a>
35          </h7><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
36    <span class="keyword">class</span> <span class="identifier">ChunkExtensions</span><span class="special">&gt;</span>
37<span class="identifier">chunk_header</span><span class="special">(</span>
38    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">,</span>
39    <span class="identifier">ChunkExtensions</span><span class="special">&amp;&amp;</span> <span class="identifier">extensions</span><span class="special">);</span>
40</pre>
41<h7><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.h1"></a>
42            <span class="phrase"><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.description"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.description">Description</a>
43          </h7><p>
44            This constructs a buffer sequence representing a <span class="emphasis"><em>chunked-body</em></span>
45            size and terminating CRLF (<code class="computeroutput"><span class="string">"\r\n"</span></code>)
46            with provided chunk extensions. The default allocator is used to provide
47            storage for the extensions object.
48          </p>
49<h7><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.h2"></a>
50            <span class="phrase"><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.parameters"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.parameters">Parameters</a>
51          </h7><div class="informaltable"><table class="table">
52<colgroup>
53<col>
54<col>
55</colgroup>
56<thead><tr>
57<th>
58                    <p>
59                      Name
60                    </p>
61                  </th>
62<th>
63                    <p>
64                      Description
65                    </p>
66                  </th>
67</tr></thead>
68<tbody>
69<tr>
70<td>
71                    <p>
72                      <code class="computeroutput"><span class="identifier">size</span></code>
73                    </p>
74                  </td>
75<td>
76                    <p>
77                      The size of the chunk body that follows. The value must be
78                      greater than zero.
79                    </p>
80                  </td>
81</tr>
82<tr>
83<td>
84                    <p>
85                      <code class="computeroutput"><span class="identifier">extensions</span></code>
86                    </p>
87                  </td>
88<td>
89                    <p>
90                      The chunk extensions object. The expression <code class="computeroutput"><span class="identifier">extensions</span><span class="special">.</span><span class="identifier">str</span><span class="special">()</span></code> must be valid, and the return
91                      type must be convertible to <a class="link" href="../../boost__beast__string_view.html" title="string_view"><code class="computeroutput"><span class="identifier">string_view</span></code></a>. This
92                      object will be copied or moved as needed to ensure that the
93                      chunk header object retains ownership of the buffers provided
94                      by the chunk extensions object.
95                    </p>
96                  </td>
97</tr>
98</tbody>
99</table></div>
100<h7><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.h3"></a>
101            <span class="phrase"><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.remarks"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.remarks">Remarks</a>
102          </h7><p>
103            This function participates in overload resolution only if <span class="bold"><strong>ChunkExtensions</strong></span>
104            meets the requirements stated above.
105          </p>
106<h7><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.h4"></a>
107            <span class="phrase"><a name="beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.see_also"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__chunk_header.chunk_header.overload3.see_also">See
108            Also</a>
109          </h7><p>
110            <a href="https://tools.ietf.org/html/rfc7230#section-4.1" target="_top">https://tools.ietf.org/html/rfc7230#section-4.1</a>
111          </p>
112</div>
113<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
114<td align="left"></td>
115<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
116      Falco<p>
117        Distributed under the Boost Software License, Version 1.0. (See accompanying
118        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>)
119      </p>
120</div></td>
121</tr></table>
122<hr>
123<div class="spirit-nav">
124<a accesskey="p" href="overload2.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../chunk_header.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="overload4.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
125</div>
126</body>
127</html>
128