Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of Boost. Click here to view this page for the latest version.
PrevUpHomeNext
websocket::stream::handshake (1 of 4 overloads)

Perform the WebSocket handshake in the client role.

Synopsis
void
handshake(
    string_view host,
    string_view target);
Description

This function is used to perform the WebSocket handshake, required before messages can be sent and received. During the handshake, the client sends the Websocket Upgrade HTTP request, and the server replies with an HTTP response indicating the result of the handshake. The call blocks until one of the following conditions is true:

The algorithm, known as a composed operation, is implemented in terms of calls to the next layer's read_some and write_some functions. The handshake is successful if the received HTTP response indicates the upgrade was accepted by the server, represented by a status-code of beast::http::status::switching_protocols.

Parameters

Name

Description

host

The name of the remote host. This is required by the HTTP protocol to set the "Host" header field.

target

The request-target, in origin-form. The server may use the target to distinguish different services on the same listening port.

Exceptions

Type

Thrown On

system_error

Thrown on failure.

Example
ws.handshake( "localhost" , "/" );
See Also

PrevUpHomeNext