...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Send an HTTP WebSocket Upgrade request and receive the response.
void handshake( string_view host, string_view target);
This function is used to synchronously send the WebSocket upgrade HTTP request. 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.
The operation is successful if the received HTTP response indicates a successful HTTP Upgrade (represented by a Status-Code of 101, "switching protocols").
Name |
Description |
---|---|
|
The name of the remote host, required by the HTTP protocol. |
|
The Request Target, which may not be empty, required by the HTTP protocol. |
Type |
Thrown On |
---|---|
|
Thrown on failure. |
websocket::stream<ip::tcp::socket> ws{io_context}; ... try { ws.handshake("localhost", "/"); } catch(...) { // An error occurred. }