Exit Zen
12
string ID 51
type: paragraph
English
The container offers value semantics including move and copy if supported by __Body__ and __Fields__. User defined template function parameters can accept any message, or can use partial specialization to accept just requests or responses. The default __fields__ is a provided associative container using the standard allocator and supporting modification and inspection of fields. As per __rfc7230__, a non-case-sensitive comparison is used for field names. User defined types for fields are possible. The `Body` type determines the type of the container used to represent the body as well as the algorithms for transferring buffers to and from the container. The library comes with a collection of common body types. As with fields, user defined body types are possible.
772/7720 · 772
13
string ID 63
type: paragraph
English
Sometimes it is desired to only work with a header. Beast provides a single class template __header__ and some aliases to model HTTP/1 and HTTP/2 headers:
154/1540 · 154
14
string ID 66
type: table title
English
Header
6/100 · 6
66
string ID 66
type: table cell
English
Name
4/100 · 4
66
string ID 66
type: table cell
English
Description
11/110 · 11
17
string ID 66
type: table cell
English
__header__
10/100 · 10
18
string ID 66
type: table code
English
/// An HTTP header
template<
bool isRequest, // `true` for requests, `false` for responses
class Fields = fields> // The type of container to store the fields
class header;
189/1890 · 189
19
string ID 66
type: table cell
English
[link beast.ref.boost__beast__http__request_header `request_header`]
68/680 · 68
20
string ID 66
type: table code
English
/// A typical HTTP request header
template<class Fields>
using request_header = header<true, Fields>;
101/1010 · 101
21
string ID 66
type: table cell
English
[link beast.ref.boost__beast__http__response_header `response_header`]
70/700 · 70
22
string ID 66
type: table code
English
/// A typical HTTP response header
template<class Fields>
using response_header = header<false, Fields>;
104/1040 · 104
23
string ID 99
type: paragraph
English
Requests and responses share the version, fields, and body but have a few members unique to the type. This is implemented by declaring the header classes as partial specializations of `isRequest`. __message__ is derived from __header__; a message may be passed as an argument to a function taking a suitably typed header as a parameter. Additionally, `header` is publicly derived from `Fields`; a message inherits all the member functions of `Fields`. This diagram shows the inheritance relationship between header and message, along with some of the notable differences in members in each partial specialization:
613/6130 · 613
24
string ID 111
type: heading
English
Body Types
10/100 · 10
25
string ID 113
type: paragraph
English
Beast defines the __Body__ concept, which determines both the type of the [link beast.ref.boost__beast__http__message.body `message::body`] member (as seen in the diagram above) and may also include algorithms for transferring buffers in and out. These algorithms are used during parsing and serialization. Users may define their own body types which meet the requirements, or use the ones that come with the library:
417/4170 · 417
26
string ID 120
type: table cell
English
[link beast.ref.boost__beast__http__buffer_body `buffer_body`]
62/620 · 62
27
string ID 120
type: table cell
English
A body whose [link beast.ref.boost__beast__http__buffer_body__value_type `value_type`] holds a raw pointer and size to a caller-provided buffer. This allows for serialization of body data coming from external sources, and incremental parsing of message body content using a fixed size buffer.
292/2920 · 292
28
string ID 120
type: table cell
English
[link beast.ref.boost__beast__http__dynamic_body `dynamic_body`]

[link beast.ref.boost__beast__http__basic_dynamic_body `basic_dynamic_body`]
142/1420 · 142
29
string ID 120
type: table cell
English
A body whose `value_type` is a __DynamicBuffer__. It inherits the insertion complexity of the underlying choice of dynamic buffer. Messages with this body type may be serialized and parsed.
189/1890 · 189
30
string ID 120
type: table cell
English
[link beast.ref.boost__beast__http__empty_body `empty_body`]
60/600 · 60
31
string ID 120
type: table cell
English
A special body with an empty `value_type` indicating that the message has no body. Messages with this body may be serialized and parsed; however, body octets received while parsing a message with this body will generate a unique error.
235/2350 · 235