...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Read and respond to a WebSocket HTTP Upgrade request.
void accept( error_code& ec);
This function is used to synchronously read an HTTP WebSocket Upgrade request and send the HTTP response. The call blocks until one of the following conditions is true:
This function is implemented in terms of one or more calls to the next
layer's read_some
and
write_some
functions.
If the stream receives a valid HTTP WebSocket Upgrade request, an HTTP response is sent back indicating a successful upgrade. When this call returns, the stream is then ready to send and receive WebSocket protocol frames and messages. If the HTTP Upgrade request is invalid or cannot be satisfied, an HTTP response is sent indicating the reason and status code (typically 400, "Bad Request"). This counts as a failure.
The implementation uses fixed size internal storage to receive the request.
If the request is too large, the error websocket::buffer_overflow
will be indicated.
Applications that wish to receive larger requests should first read the
request using their own buffer and a suitable overload of http::read
or http::async_read
, then call websocket::stream::accept
or websocket::stream::async_accept
with the request.
Name |
Description |
---|---|
|
Set to indicate what error occurred, if any. |