English

Decorator

English

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:

English

WebSocket Decorator Interface

English

Name

English

Description

English

[link beast.ref.boost__beast__websocket__request_type `request_type`]

English

This is the type of the object passed to the decorator to represent HTTP Upgrade requests.

English

[link beast.ref.boost__beast__websocket__response_type `response_type`]

English

This is the type of the object passed to the decorator to represent HTTP Upgrade response.

English

[link beast.ref.boost__beast__websocket__stream_base__decorator `stream_base::decorator`]

English

Objects of this type are used to hold a decorator to be set on the stream using `set_option`.

English

[link beast.ref.boost__beast__websocket__stream.set_option `stream::set_option`]

English

This function is used to set a `stream_base::decorator` on the stream.

English

This declares a normal function which decorates outgoing HTTP requests:

English

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:

English

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:

English

A lambda may be used in place of a named function object:

English

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:

English

The implementation takes ownership by decay-copy of the invocable object used as the decorator. Move-only types are possible:

English

Undefined behavior results if the decorator modifies the fields