Zen

Source string Source string

type: table cell
130/10000 · 130

The string is read-only.

Key English Actions
__header__
/// 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;
[link beast.ref.boost__beast__http__request_header `request_header`]
/// A typical HTTP request header
template<class Fields>
using request_header = header<true, Fields>;
[link beast.ref.boost__beast__http__response_header `response_header`]
/// A typical HTTP response header
template<class Fields>
using response_header = header<false, Fields>;
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:
Body Types
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:
[link beast.ref.boost__beast__http__buffer_body `buffer_body`]
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.
[link beast.ref.boost__beast__http__dynamic_body `dynamic_body`]

[link beast.ref.boost__beast__http__basic_dynamic_body `basic_dynamic_body`]
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.
[link beast.ref.boost__beast__http__empty_body `empty_body`]
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.
[link beast.ref.boost__beast__http__file_body `file_body`]

[link beast.ref.boost__beast__http__basic_file_body `basic_file_body`]
This body is represented by a file opened for either reading or writing. Messages with this body may be serialized and parsed. HTTP algorithms will use the open file for reading and writing, for streaming and incremental sends and receives.
[link beast.ref.boost__beast__http__span_body `span_body`]
A body whose `value_type` is a [@boost:/libs/core/doc/html/core/span.html `span`], a non-owning reference to a single linear buffer of bytes. Messages with this body type may be serialized and parsed.
[link beast.ref.boost__beast__http__string_body `string_body`]

[link beast.ref.boost__beast__http__basic_string_body `basic_string_body`]
A body whose `value_type` is `std::basic_string` or `std::string`. Insertion complexity is amortized constant time, while capacity grows geometrically. Messages with this body type may be serialized and parsed. This is the type of body used in the examples.
[link beast.ref.boost__beast__http__vector_body `vector_body`]
A body whose `value_type` is `std::vector`. Insertion complexity is amortized constant time, while capacity grows geometrically. Messages with this body type may be serialized and parsed.
Usage
These examples show how to create and fill in request and response objects: Here we build an [@https://tools.ietf.org/html/rfc7231#section-4.3.1 HTTP GET] request with an empty message body:
Create Request
193
Statements
193
Serialized Result
[http_snippet_2]
GET /index.htm HTTP/1.1\r\n
Accept: text/html\r\n
User-Agent: Beast\r\n
\r\n
In this code we create an HTTP response with a status code indicating success. This message has a body with a non-zero length. The function [link beast.ref.boost__beast__http__message.prepare_payload `message::prepare_payload`] automatically sets the Content-Length or Transfer-Encoding field depending on the content and type of the `body` member. Use of this function is optional; these fields may also be set explicitly.
Key English Actions
Usage
These examples show how to create and fill in request and response objects: Here we build an [@https://tools.ietf.org/html/rfc7231#section-4.3.1 HTTP GET] request with an empty message body:
__header__
/// 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;
[link beast.ref.boost__beast__http__request_header `request_header`]
/// A typical HTTP request header
template<class Fields>
using request_header = header<true, Fields>;
[link beast.ref.boost__beast__http__response_header `response_header`]
/// A typical HTTP response header
template<class Fields>
using response_header = header<false, Fields>;
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:
Body Types
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:
[link beast.ref.boost__beast__http__buffer_body `buffer_body`]
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.
[link beast.ref.boost__beast__http__dynamic_body `dynamic_body`]

[link beast.ref.boost__beast__http__basic_dynamic_body `basic_dynamic_body`]
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.
[link beast.ref.boost__beast__http__empty_body `empty_body`]
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.
[link beast.ref.boost__beast__http__file_body `file_body`]

[link beast.ref.boost__beast__http__basic_file_body `basic_file_body`]
This body is represented by a file opened for either reading or writing. Messages with this body may be serialized and parsed. HTTP algorithms will use the open file for reading and writing, for streaming and incremental sends and receives.
[link beast.ref.boost__beast__http__span_body `span_body`]
A body whose `value_type` is a [@boost:/libs/core/doc/html/core/span.html `span`], a non-owning reference to a single linear buffer of bytes. Messages with this body type may be serialized and parsed.
[link beast.ref.boost__beast__http__string_body `string_body`]

[link beast.ref.boost__beast__http__basic_string_body `basic_string_body`]
A body whose `value_type` is `std::basic_string` or `std::string`. Insertion complexity is amortized constant time, while capacity grows geometrically. Messages with this body type may be serialized and parsed. This is the type of body used in the examples.
[link beast.ref.boost__beast__http__vector_body `vector_body`]
A body whose `value_type` is `std::vector`. Insertion complexity is amortized constant time, while capacity grows geometrically. Messages with this body type may be serialized and parsed.
17
Name
17
Description
193
Statements
193
Serialized Result
214
Serialized Result

Loading…

User avatar admin

String added in the repository
[link beast.ref.boost__beast__http__file_body `file_body`]

[link beast.ref.boost__beast__http__basic_file_body `basic_file_body`]
[link beast.ref.boost__beast__http__file_body `file_body`]

[link beast.ref.boost__beast__http__basic_file_body `basic_file_body`]
06/05/2026
Browse all string changes

Glossary

English English
No related strings found in the glossary.

String information

Component
Boost Beast Translation (zh_Hans)/Doc / Qbk / 04 Http / 02 Message (qbk)
Source string description
type: table cell
Flags
read-only
Unit identifier
57313
Source string location
string ID 120
String age
06/05/2026
Last updated
06/05/2026
Source string age
06/05/2026
Translation file QuickBook file
doc/qbk/04_http/02_message.qbk, string 32