User avatar Bstran

Translation changed
Handshake Buffering
Handshake Buffering握手缓冲机制
06/18/2026
User avatar Bstran

Translation changed
The [link beast.ref.boost__beast__websocket__stream `stream`] member functions [link beast.ref.boost__beast__websocket__stream.accept `accept`] and [link beast.ref.boost__beast__websocket__stream.async_accept `async_accept`] are used to read the WebSocket HTTP Upgrade request handshake from a stream already connected to an incoming peer, and then send the WebSocket HTTP Upgrade response, as shown:
The [link beast.ref.boost__beast__websocket__stream `stream`] member functions的成员函数 [link beast.ref.boost__beast__websocket__stream.accept `accept`] and和 [link beast.ref.boost__beast__websocket__stream.async_accept `async_accept`] are used to read the WebSocket HTTP Upgrade request handshake from a stream already connected to an incoming peer, and then send the WebSocket HTTP Upgrade response, as shown:用于从已连接入站对端的流中读取 WebSocket HTTP 升级请求握手，然后发送 WebSocket HTTP 升级响应，用法如下：
06/18/2026
User avatar Bstran

Translation changed
The [@https://tools.ietf.org/html/rfc6455#section-11.3.3 ['Sec-WebSocket-Accept]] field value is generated from the request in a fashion specified by the WebSocket protocol.
The [@https://tools.ietf.org/html/rfc6455#section-11.3.3 ['`Sec-WebSocket-Accept]] field value is generated from the request in a fashion specified by the WebSocket protocol.`] 字段值按照 WebSocket 协议规定的方式根据请求生成。
06/18/2026
User avatar Bstran

Translation changed
HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: upgrade
Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
Server: Boost.Beast
HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: upgrade
Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
Server: Boost.Beast
06/18/2026
User avatar Bstran

Translation changed
Description
Description描述
89
06/18/2026
User avatar Bstran

Translation changed
Wire Format
Wire Format线路格式
89
06/18/2026
User avatar Bstran

Translation changed
WebSocket Upgrade HTTP Response
WebSocket Upgrade HTTP Response升级 HTTP 响应
06/18/2026
User avatar Bstran

Translation changed
For servers accepting incoming connections, the [link beast.ref.boost__beast__websocket__stream `websocket::stream`] can read the incoming upgrade request and automatically reply. If the handshake meets the requirements, the stream sends back the upgrade response with a [@https://tools.ietf.org/html/rfc6455#section-4.2.2 ['101 Switching Protocols]] status code. If the handshake does not meet the requirements, or falls outside the range of allowed parameters specified by stream options set previously by the caller, the stream sends back an HTTP response with a status code indicating an error. Depending on the keep alive setting, the connection may remain open for a subsequent handshake attempt. A typical HTTP Upgrade response created and sent by the implementation upon receiving an upgrade request handshake will look like this:
For servers accepting incoming connections, the 对于接受入站连接的服务器，[link beast.ref.boost__beast__websocket__stream `websocket::stream`] can read the incoming upgrade request and automatically reply. If the handshake meets the requirements, the stream sends back the upgrade response with a [@https://tools.ietf.org/html/rfc6455#section-4.2.2 ['101 Switching Protocols]] status code. If the handshake does not meet the requirements, or falls outside the range of allowed parameters specified by stream options set previously by the caller, the stream sends back an HTTP response with a status code indicating an error. Depending on the可以读取入站升级请求并自动回复。如果握手满足要求，流会返回一个状态码为 `101 Switching Protocols` 的升级响应。如果握手不符合要求，或超出调用方先前设置的流选项所允许的参数范围，流会返回一个带有错误状态码的 HTTP 响应。根据 keep -alive setting, the connection may remain open for a subsequent handshake attempt. A typical HTTP Upgrade response created and sent by the implementation upon receiving an upgrade request handshake will look like this:设置，连接可能会保持打开状态，以便后续再次尝试握手。当接收到升级请求握手时，实现创建并发送的典型 HTTP 升级响应如下所示：
06/18/2026
User avatar Bstran

Translation changed
Server Role
Server Role服务器角色
06/18/2026
User avatar Bstran

Translation changed
When a client receives an HTTP Upgrade response from the server indicating a successful upgrade, the caller may wish to perform additional validation on the received HTTP response message. For example, to check that the response to a basic authentication challenge is valid. To achieve this, overloads of the handshake member function allow the caller to store the received HTTP message in an output reference argument of type [link beast.ref.boost__beast__websocket__response_type `response_type`] as follows:
When a client receives an HTTP Upgrade response from the server indicating a successful upgrade, the caller may wish to perform additional validation on the received HTTP response message. For example, to check that the response to a basic authentication challenge is valid. To achieve this, overloads of the handshake member function allow the caller to store the received HTTP message in an output reference argument of type当客户端收到服务器返回的表示升级成功的 HTTP Upgrade 响应时，调用方可能希望对收到的 HTTP 响应消息进行额外验证。例如，检查基本认证质询的响应是否有效。为此，handshake 成员函数的重载版本允许调用方将收到的 HTTP 消息存储到一个输出引用参数中，该参数类型为 [link beast.ref.boost__beast__websocket__response_type `response_type`] as follows:，用法如下：
06/18/2026
User avatar Bstran

Translation changed
The [link beast.ref.boost__beast__websocket__stream `websocket::stream`] member functions [link beast.ref.boost__beast__websocket__stream.handshake `handshake`] and [link beast.ref.boost__beast__websocket__stream.async_handshake `async_handshake`] are used to send the request with the required host and target strings. This code connects to the IP address returned from a hostname lookup, then performs the WebSocket handshake in the client role.
The [link beast.ref.boost__beast__websocket__stream `websocket::stream`] member functions的成员函数 [link beast.ref.boost__beast__websocket__stream.handshake `handshake`] and和 [link beast.ref.boost__beast__websocket__stream.async_handshake `async_handshake`] are used to send the request with the required host and target strings. This code connects to the IP address returned from a hostname lookup, then performs the WebSocket handshake in the client role.用于发送包含所需主机和目标字符串的请求。以下代码先连接到通过主机名解析获得的 IP 地址，然后以客户端角色执行 WebSocket 握手。
06/18/2026
User avatar Bstran

Translation changed
The host and target parameters become part of the Host field and request-target in the resulting HTTP request. The key is generated by the implementation. Callers who wish to add, modify, or inspect fields may set the ['decorator] option on the stream (described later).
The host and target parameters become part of the Host field and request-target in the resulting HTTP request. The key is generated by the implementation. Callers who wish to add, modify, or inspect fields may set the ['decorator] option on the stream (described later).主机和目标参数会分别填入所生成的 HTTP 请求中，分别对应 Host 字段和请求目标。密钥由实现自行生成。如果调用方需要添加、修改或检查字段，可以在流上设置修饰器选项（详见下文）。
06/18/2026
User avatar Bstran

Translation changed
GET / HTTP/1.1
Host: www.example.com
Upgrade: websocket
Connection: upgrade
Sec-WebSocket-Key: 2pGeTR0DsE4dfZs2pH+8MA==
Sec-WebSocket-Version: 13
User-Agent: Boost.Beast/216
GET / HTTP/1.1
Host: www.example.com
Upgrade: websocket
Connection: upgrade
Sec-WebSocket-Key: 2pGeTR0DsE4dfZs2pH+8MA==
Sec-WebSocket-Version: 13
User-Agent: Boost.Beast/216
06/18/2026
User avatar Bstran

Translation changed
Description
Description描述
30
06/18/2026
User avatar Bstran

Translation changed
Wire Format
Wire Format线路格式
30
06/18/2026
User avatar Bstran

Translation changed
WebSocket HTTP Upgrade Request
WebSocket HTTP Upgrade Request升级请求
06/18/2026
User avatar Bstran

Translation changed
A WebSocket session begins when a client sends the HTTP/1.1 [@https://tools.ietf.org/html/rfc7230#section-6.7 Upgrade] request for [@https://tools.ietf.org/html/rfc6455#section-1.3 WebSocket] on an established connection, and the server sends an appropriate response indicating that the request was accepted and that the connection has been upgraded. The Upgrade request must include the [@https://tools.ietf.org/html/rfc7230#section-5.4 Host] field, and the [@https://tools.ietf.org/html/rfc7230#section-5.3 target] of the resource to request. A typical HTTP Upgrade request created and sent by the implementation will look like this:
A WebSocket session begins when a client sends the会话的建立过程如下：客户端在已建立的连接上发送 HTTP/1.1 [@https://tools.ietf.org/html/rfc7230#section-6.7 Upgrade] request for [@https://tools.ietf.org/html/rfc6455#section-1.3 WebSocket] on an established connection, and the server sends an appropriate response indicating that the request was accepted and that the connection has been upgraded. The Upgrade request must include the请求，服务器则返回相应响应，表示接受该升级请求。该 Upgrade 请求必须包含 [@https://tools.ietf.org/html/rfc7230#section-5.4 Host] field, and the字段以及所请求资源的 [@https://tools.ietf.org/html/rfc7230#section-5.3 target] of the resource to request. A typical HTTP Upgrade request created and sent by the implementation will look like this:目标]。由实现创建并发送的典型 HTTP Upgrade 请求如下所示：
06/18/2026
User avatar Bstran

Translation changed
Client Role
Client Role客户端角色
06/18/2026
User avatar Bstran

Translation changed
Handshaking
Handshaking握手
06/18/2026
User avatar Bstran

Contributor joined
Contributor joined 06/18/2026

Search