Boost C++ Libraries 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 a snapshot of the develop branch, built from commit b966fb37fe.

Simple WebSocket Client 💡

Establish a WebSocket connection, send a message and receive the reply:

File: websocket_sync_client.cpp

#include <boost/beast/core.hpp>
#include <boost/beast/websocket.hpp>
#include <boost/asio/connect.hpp>
#include <boost/asio/ip/tcp.hpp>
#include <cstdlib>
#include <iostream>
#include <string>

namespace beast = boost::beast;         // from <boost/beast.hpp>
namespace http = beast::http;           // from <boost/beast/http.hpp>
namespace websocket = beast::websocket; // from <boost/beast/websocket.hpp>
namespace net = boost::asio;            // from <boost/asio.hpp>
using tcp = boost::asio::ip::tcp;       // from <boost/asio/ip/tcp.hpp>

// Sends a WebSocket message and prints the response
int main(int argc, char** argv)
        // Check command line arguments.
        if(argc != 4)
            std::cerr <<
                "Usage: websocket-client-sync <host> <port> <text>\n" <<
                "Example:\n" <<
                "    websocket-client-sync 80 \"Hello, world!\"\n";
            return EXIT_FAILURE;
        std::string host = argv[1];
        auto const  port = argv[2];
        auto const  text = argv[3];

        // The io_context is required for all I/O
        net::io_context ioc;

        // These objects perform our I/O
        tcp::resolver resolver{ioc};
        websocket::stream<tcp::socket> ws{ioc};

        // Look up the domain name
        auto const results = resolver.resolve(host, port);

        // Make the connection on the IP address we get from a lookup
        auto ep = net::connect(ws.next_layer(), results);

        // Update the host_ string. This will provide the value of the
        // Host HTTP header during the WebSocket handshake.
        // See
        host += ':' + std::to_string(ep.port());

        // Set a decorator to change the User-Agent of the handshake
            [](websocket::request_type& req)
                    std::string(BOOST_BEAST_VERSION_STRING) +
                        " websocket-client-coro");

        // Perform the websocket handshake
        ws.handshake(host, "/");

        // Send the message

        // This buffer will hold the incoming message
        beast::flat_buffer buffer;

        // Read a message into our buffer;

        // Close the WebSocket connection

        // If we get here then the connection is closed gracefully

        // The make_printable() function helps print a ConstBufferSequence
        std::cout << beast::make_printable( << std::endl;
    catch(std::exception const& e)
        std::cerr << "Error: " << e.what() << std::endl;
        return EXIT_FAILURE;
    return EXIT_SUCCESS;