Exit Zen
20
string ID 51
type: table cell
English
This type represents the memory associated with the output sequence.
68/680 · 68
20
string ID 30
type: table cell
English
This static member function is optional. It returns the payload size of `body` in bytes not including any chunked transfer encoding. The return value may be zero, to indicate that the message is known to have no payload. The function shall not exit via an exception.

When this function is present:

* The function shall not fail

* A call to [link beast.ref.boost__beast__http__message.payload_size `message::payload_size`] will return the same value as `size`.

* A call to [link beast.ref.boost__beast__http__message.prepare_payload `message::prepare_payload`] will remove "chunked" from the Transfer-Encoding field if it appears as the last encoding, and will set the Content-Length field to the returned value.

Otherwise, when the function is omitted:

* A call to [link beast.ref.boost__beast__http__message.payload_size `message::payload_size`] will return `boost::none`.

* A call to [link beast.ref.boost__beast__http__message.prepare_payload `message::prepare_payload`] will erase the Content-Length field, and add "chunked" as the last encoding in the Transfer-Encoding field if it is not already present.
1117/11170 · 1117
20
string ID 127
type: list
English
* The `string<Tag> customization point constrains user defined body types
73/730 · 73
20
string ID 50
type: table cell
English
Called once to fully initialize the object before any calls to `get`. The message body becomes valid before entering this function, and remains valid until the writer is destroyed. The function will ensure that `!ec` is `true` if there was no error or set to the appropriate error code if there was one.
303/3030 · 303
20
string ID 36
type: table cell
English
`c.get_reason_impl()`
21/210 · 21
20
string ID 88
type: section title
English
Read From std::istream __example__
34/340 · 34
20
string ID 81
type: paragraph
English
Undefined behavior results if the decorator modifies the fields
63/630 · 63
20
string ID 21
type: table cell
English
[link beast.ref.boost__beast__buffers_suffix `buffers_suffix`]
62/620 · 62
20
string ID 119
type: paragraph
English
It is possible for servers to read data from the stream and decide later that the buffered bytes should be interpreted as a WebSocket upgrade request. To address this usage, overloads of [link beast.ref.boost__beast__websocket__stream.accept `accept`] and [link beast.ref.boost__beast__websocket__stream.async_accept `async_accept`] which accept an additional buffer sequence parameter are provided.
399/3990 · 399
20
string ID 36
type: table cell
English
`a.available_write_bytes()`
27/270 · 27
20
string ID 97
type: paragraph
English
Use of the flexible __Body__ concept customization point enables authors to preserve the self-contained nature of the __message__ object while allowing domain specific behaviors. Common operations for HTTP servers include sending responses which deliver file contents, and allowing for file uploads. In this example we build the [link beast.ref.boost__beast__http__basic_file_body `basic_file_body`] type which supports both reading and writing to a file on the file system. The interface is a class templated on the type of file used to access the file system, which must meet the requirements of __File__.
607/6070 · 607
20
string ID 16
type: variablelist cell
English
Cookies, or managing these types of HTTP headers in general, is the responsibility of higher levels. Beast just tries to get complete messages to and from the calling code. It deals in the HTTP headers just enough to process the message body and leaves the rest to callers. However, for forms and file uploads the symmetric interface of the message class allows HTTP requests to include arbitrary body types including those needed to upload a file or fill out a form.
467/4670 · 467
20
string ID 44
type: table cell
English
[link beast.ref.boost__beast__websocket__stream_base__timeout.idle_timeout `timeout::idle_timeout`]
99/990 · 99
20
string ID 136
type: paragraph
English
Since reads and writes can take place concurrently, it is possible to have two simultaneous logical operations where each operation either only reads, or only writes. The beginning of a new read or write operation will use the most recently set timeout. This will not affect operations that are already outstanding.
315/3150 · 315
20
string ID 147
type: paragraph
English
This function can manipulate the fields common to requests and responses. If it needs to access the other fields, it can use overloads with partial specialization, or in C++17 a `constexpr` expression: ``` template<bool isRequest, class Fields, class Body> void f(message<isRequest, Fields, Body>& msg) {
304/3040 · 304
20
string ID 115
type: paragraph
English
To use WebSockets over SSL, use an instance of the __ssl_stream__ class template as the template type for the stream. The required __io_context__ and __ssl_context__ arguments are forwarded to the wrapped stream's constructor:
226/2260 · 226
20
string ID 140
type: paragraph
English
This example reads from a child process and sends the output back in an HTTP response. The output of the process is sent as it becomes available:
145/1450 · 145
20
string ID 100
type: heading
English
Private Key
11/110 · 11
20
string ID 81
type: paragraph
English
Please visit the [@boost:/more/getting_started.html Boost documentation] for instructions on how to build and link with Boost libraries for your particular environment system.
175/1750 · 175
20
string ID 46
type: table cell
English
[link beast.ref.boost__beast__lowest_layer_type `lowest_layer_type`]
68/680 · 68