Zen

Translation

type: paragraph
When using a decorator, it must be set on the stream before any handshaking takes place. This sets the decorator on the stream, to be used for all subsequent calls to accept or handshake:
187/1870 · 187

Sign in to save translations.

English Chinese (Simplified Han script) Actions
Decorator
Decorator
For programs which need to modify either the outgoing WebSocket HTTP Upgrade request, the outgoing WebSocket HTTP Upgrade response, or both, the stream supports an optional property called a ['decorator]. This is a function pointer or callable object which is invoked before the implementation sends an HTTP message. The decorator receives a modifiable reference to the message, allowing for modifications. The interface to this system uses:
For programs which need to modify either the outgoing WebSocket HTTP Upgrade request, the outgoing WebSocket HTTP Upgrade response, or both, the stream supports an optional property called a ['decorator]. This is a function pointer or callable object which is invoked before the implementation sends an HTTP message. The decorator receives a modifiable reference to the message, allowing for modifications. The interface to this system uses:
WebSocket Decorator Interface
WebSocket Decorator Interface
Name
Name
Description
Description
[link beast.ref.boost__beast__websocket__request_type `request_type`]
[link beast.ref.boost__beast__websocket__request_type `request_type`]
This is the type of the object passed to the decorator to represent HTTP Upgrade requests.
This is the type of the object passed to the decorator to represent HTTP Upgrade requests.
[link beast.ref.boost__beast__websocket__response_type `response_type`]
[link beast.ref.boost__beast__websocket__response_type `response_type`]
This is the type of the object passed to the decorator to represent HTTP Upgrade response.
This is the type of the object passed to the decorator to represent HTTP Upgrade response.
[link beast.ref.boost__beast__websocket__stream_base__decorator `stream_base::decorator`]
[link beast.ref.boost__beast__websocket__stream_base__decorator `stream_base::decorator`]
Objects of this type are used to hold a decorator to be set on the stream using `set_option`.
Objects of this type are used to hold a decorator to be set on the stream using `set_option`.
[link beast.ref.boost__beast__websocket__stream.set_option `stream::set_option`]
[link beast.ref.boost__beast__websocket__stream.set_option `stream::set_option`]
This function is used to set a `stream_base::decorator` on the stream.
This function is used to set a `stream_base::decorator` on the stream.
This declares a normal function which decorates outgoing HTTP requests:
This declares a normal function which decorates outgoing HTTP requests:
When using a decorator, it must be set on the stream before any handshaking takes place. This sets the decorator on the stream, to be used for all subsequent calls to accept or handshake:
When using a decorator, it must be set on the stream before any handshaking takes place. This sets the decorator on the stream, to be used for all subsequent calls to accept or handshake:
Alternatively, a function object may be used. Small function objects will not incur a memory allocation. The follow code declares and sets a function object as a decorator:
Alternatively, a function object may be used. Small function objects will not incur a memory allocation. The follow code declares and sets a function object as a decorator:
A lambda may be used in place of a named function object:
A lambda may be used in place of a named function object:
It also possible for a single decorator to handle both requests and responses, if it is overloaded for both types either as a generic lambda (C++14 and later) or as a class as shown here:
It also possible for a single decorator to handle both requests and responses, if it is overloaded for both types either as a generic lambda (C++14 and later) or as a class as shown here:
The implementation takes ownership by decay-copy of the invocable object used as the decorator. Move-only types are possible:
The implementation takes ownership by decay-copy of the invocable object used as the decorator. Move-only types are possible:
Undefined behavior results if the decorator modifies the fields
Undefined behavior results if the decorator modifies the fields
English Chinese (Simplified Han script) Actions
Decorator
Decorator
For programs which need to modify either the outgoing WebSocket HTTP Upgrade request, the outgoing WebSocket HTTP Upgrade response, or both, the stream supports an optional property called a ['decorator]. This is a function pointer or callable object which is invoked before the implementation sends an HTTP message. The decorator receives a modifiable reference to the message, allowing for modifications. The interface to this system uses:
For programs which need to modify either the outgoing WebSocket HTTP Upgrade request, the outgoing WebSocket HTTP Upgrade response, or both, the stream supports an optional property called a ['decorator]. This is a function pointer or callable object which is invoked before the implementation sends an HTTP message. The decorator receives a modifiable reference to the message, allowing for modifications. The interface to this system uses:
WebSocket Decorator Interface
WebSocket Decorator Interface
Name
Name
Description
Description
[link beast.ref.boost__beast__websocket__request_type `request_type`]
[link beast.ref.boost__beast__websocket__request_type `request_type`]
This is the type of the object passed to the decorator to represent HTTP Upgrade requests.
This is the type of the object passed to the decorator to represent HTTP Upgrade requests.
[link beast.ref.boost__beast__websocket__response_type `response_type`]
[link beast.ref.boost__beast__websocket__response_type `response_type`]
This is the type of the object passed to the decorator to represent HTTP Upgrade response.
This is the type of the object passed to the decorator to represent HTTP Upgrade response.
[link beast.ref.boost__beast__websocket__stream_base__decorator `stream_base::decorator`]
[link beast.ref.boost__beast__websocket__stream_base__decorator `stream_base::decorator`]
Objects of this type are used to hold a decorator to be set on the stream using `set_option`.
Objects of this type are used to hold a decorator to be set on the stream using `set_option`.
[link beast.ref.boost__beast__websocket__stream.set_option `stream::set_option`]
[link beast.ref.boost__beast__websocket__stream.set_option `stream::set_option`]
This function is used to set a `stream_base::decorator` on the stream.
This function is used to set a `stream_base::decorator` on the stream.
This declares a normal function which decorates outgoing HTTP requests:
This declares a normal function which decorates outgoing HTTP requests:
When using a decorator, it must be set on the stream before any handshaking takes place. This sets the decorator on the stream, to be used for all subsequent calls to accept or handshake:
When using a decorator, it must be set on the stream before any handshaking takes place. This sets the decorator on the stream, to be used for all subsequent calls to accept or handshake:
Alternatively, a function object may be used. Small function objects will not incur a memory allocation. The follow code declares and sets a function object as a decorator:
Alternatively, a function object may be used. Small function objects will not incur a memory allocation. The follow code declares and sets a function object as a decorator:
A lambda may be used in place of a named function object:
A lambda may be used in place of a named function object:
It also possible for a single decorator to handle both requests and responses, if it is overloaded for both types either as a generic lambda (C++14 and later) or as a class as shown here:
It also possible for a single decorator to handle both requests and responses, if it is overloaded for both types either as a generic lambda (C++14 and later) or as a class as shown here:
The implementation takes ownership by decay-copy of the invocable object used as the decorator. Move-only types are possible:
The implementation takes ownership by decay-copy of the invocable object used as the decorator. Move-only types are possible:
Undefined behavior results if the decorator modifies the fields
Undefined behavior results if the decorator modifies the fields

Loading…

User avatar admin

String added in the repository
When using a decorator, it must be set on the stream before any handshaking takes place. This sets the decorator on the stream, to be used for all subsequent calls to accept or handshake:
When using a decorator, it must be set on the stream before any handshaking takes place. This sets the decorator on the stream, to be used for all subsequent calls to accept or handshake:
06/05/2026
Browse all string changes

Things to check

Unchanged translation

Source and translation are identical.

Reset

Glossary

English Chinese (Simplified Han script)
No related strings found in the glossary.

String information

Source string description
type: paragraph
Unit identifier
58897
Source string location
string ID 53
String age
06/05/2026
Last updated
06/05/2026
Source string age
06/05/2026
Translation file QuickBook file
doc/qbk/06_websocket/03_decorator_zh_Hans.qbk, string 15