libs/beast/example/websocket/server/fast/websocket_server_fast.cpp
//
// Copyright (c) 2016-2019 Vinnie Falco (vinnie dot falco at gmail dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
// Official repository: https://github.com/boostorg/beast
//
//------------------------------------------------------------------------------
//
// Example: WebSocket server, fast
//
//------------------------------------------------------------------------------
/* This server contains the following ports:
Synchronous <base port + 0>
Asynchronous <base port + 1>
Coroutine <base port + 2>
This program is optimized for the Autobahn|Testsuite
benchmarking and WebSocket compliants testing program.
See:
https://github.com/crossbario/autobahn-testsuite
*/
#include <boost/beast/core.hpp>
#include <boost/beast/http.hpp>
#include <boost/beast/version.hpp>
#include <boost/beast/websocket.hpp>
#include <boost/asio/spawn.hpp>
#include <boost/asio/strand.hpp>
#include <algorithm>
#include <cstdlib>
#include <functional>
#include <iostream>
#include <memory>
#include <string>
#include <thread>
#include <vector>
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>
//------------------------------------------------------------------------------
// Report a failure
void
fail(beast::error_code ec, char const* what)
{
std::cerr << (std::string(what) + ": " + ec.message() + "\n");
}
// Adjust settings on the stream
template<class NextLayer>
void
setup_stream(websocket::stream<NextLayer>& ws)
{
// These values are tuned for Autobahn|Testsuite, and
// should also be generally helpful for increased performance.
websocket::permessage_deflate pmd;
pmd.client_enable = true;
pmd.server_enable = true;
pmd.compLevel = 3;
ws.set_option(pmd);
ws.auto_fragment(false);
// Autobahn|Testsuite needs this
ws.read_message_max(64 * 1024 * 1024);
}
//------------------------------------------------------------------------------
void
do_sync_session(websocket::stream<beast::tcp_stream>& ws)
{
beast::error_code ec;
setup_stream(ws);
// Set a decorator to change the Server of the handshake
ws.set_option(websocket::stream_base::decorator(
[](websocket::response_type& res)
{
res.set(http::field::server, std::string(
BOOST_BEAST_VERSION_STRING) + "-Sync");
}));
ws.accept(ec);
if(ec)
return fail(ec, "accept");
for(;;)
{
beast::flat_buffer buffer;
ws.read(buffer, ec);
if(ec == websocket::error::closed)
break;
if(ec)
return fail(ec, "read");
ws.text(ws.got_text());
ws.write(buffer.data(), ec);
if(ec)
return fail(ec, "write");
}
}
void
do_sync_listen(
net::io_context& ioc,
tcp::endpoint endpoint)
{
beast::error_code ec;
tcp::acceptor acceptor{ioc, endpoint};
for(;;)
{
tcp::socket socket{ioc};
acceptor.accept(socket, ec);
if(ec)
return fail(ec, "accept");
std::thread(std::bind(
&do_sync_session,
websocket::stream<beast::tcp_stream>(
std::move(socket)))).detach();
}
}
//------------------------------------------------------------------------------
// Echoes back all received WebSocket messages
class async_session : public std::enable_shared_from_this<async_session>
{
websocket::stream<beast::tcp_stream> ws_;
beast::flat_buffer buffer_;
public:
// Take ownership of the socket
explicit
async_session(tcp::socket&& socket)
: ws_(std::move(socket))
{
setup_stream(ws_);
}
// Start the asynchronous operation
void
run()
{
// Set suggested timeout settings for the websocket
ws_.set_option(
websocket::stream_base::timeout::suggested(
beast::role_type::server));
// Set a decorator to change the Server of the handshake
ws_.set_option(websocket::stream_base::decorator(
[](websocket::response_type& res)
{
res.set(http::field::server, std::string(
BOOST_BEAST_VERSION_STRING) + "-Async");
}));
// Accept the websocket handshake
ws_.async_accept(
beast::bind_front_handler(
&async_session::on_accept,
shared_from_this()));
}
void
on_accept(beast::error_code ec)
{
if(ec)
return fail(ec, "accept");
// Read a message
do_read();
}
void
do_read()
{
// Read a message into our buffer
ws_.async_read(
buffer_,
beast::bind_front_handler(
&async_session::on_read,
shared_from_this()));
}
void
on_read(
beast::error_code ec,
std::size_t bytes_transferred)
{
boost::ignore_unused(bytes_transferred);
// This indicates that the async_session was closed
if(ec == websocket::error::closed)
return;
if(ec)
fail(ec, "read");
// Echo the message
ws_.text(ws_.got_text());
ws_.async_write(
buffer_.data(),
beast::bind_front_handler(
&async_session::on_write,
shared_from_this()));
}
void
on_write(
beast::error_code ec,
std::size_t bytes_transferred)
{
boost::ignore_unused(bytes_transferred);
if(ec)
return fail(ec, "write");
// Clear the buffer
buffer_.consume(buffer_.size());
// Do another read
do_read();
}
};
// Accepts incoming connections and launches the sessions
class async_listener : public std::enable_shared_from_this<async_listener>
{
net::io_context& ioc_;
tcp::acceptor acceptor_;
public:
async_listener(
net::io_context& ioc,
tcp::endpoint endpoint)
: ioc_(ioc)
, acceptor_(net::make_strand(ioc))
{
beast::error_code ec;
// Open the acceptor
acceptor_.open(endpoint.protocol(), ec);
if(ec)
{
fail(ec, "open");
return;
}
// Allow address reuse
acceptor_.set_option(net::socket_base::reuse_address(true), ec);
if(ec)
{
fail(ec, "set_option");
return;
}
// Bind to the server address
acceptor_.bind(endpoint, ec);
if(ec)
{
fail(ec, "bind");
return;
}
// Start listening for connections
acceptor_.listen(
net::socket_base::max_listen_connections, ec);
if(ec)
{
fail(ec, "listen");
return;
}
}
// Start accepting incoming connections
void
run()
{
do_accept();
}
private:
void
do_accept()
{
// The new connection gets its own strand
acceptor_.async_accept(
net::make_strand(ioc_),
beast::bind_front_handler(
&async_listener::on_accept,
shared_from_this()));
}
void
on_accept(beast::error_code ec, tcp::socket socket)
{
if(ec)
{
fail(ec, "accept");
}
else
{
// Create the async_session and run it
std::make_shared<async_session>(std::move(socket))->run();
}
// Accept another connection
do_accept();
}
};
//------------------------------------------------------------------------------
void
do_coro_session(
websocket::stream<beast::tcp_stream>& ws,
net::yield_context yield)
{
beast::error_code ec;
setup_stream(ws);
// Set suggested timeout settings for the websocket
ws.set_option(
websocket::stream_base::timeout::suggested(
beast::role_type::server));
// Set a decorator to change the Server of the handshake
ws.set_option(websocket::stream_base::decorator(
[](websocket::response_type& res)
{
res.set(http::field::server, std::string(
BOOST_BEAST_VERSION_STRING) + "-Fiber");
}));
ws.async_accept(yield[ec]);
if(ec)
return fail(ec, "accept");
for(;;)
{
beast::flat_buffer buffer;
ws.async_read(buffer, yield[ec]);
if(ec == websocket::error::closed)
break;
if(ec)
return fail(ec, "read");
ws.text(ws.got_text());
ws.async_write(buffer.data(), yield[ec]);
if(ec)
return fail(ec, "write");
}
}
void
do_coro_listen(
net::io_context& ioc,
tcp::endpoint endpoint,
net::yield_context yield)
{
beast::error_code ec;
tcp::acceptor acceptor(ioc);
acceptor.open(endpoint.protocol(), ec);
if(ec)
return fail(ec, "open");
acceptor.set_option(net::socket_base::reuse_address(true), ec);
if(ec)
return fail(ec, "set_option");
acceptor.bind(endpoint, ec);
if(ec)
return fail(ec, "bind");
acceptor.listen(net::socket_base::max_listen_connections, ec);
if(ec)
return fail(ec, "listen");
for(;;)
{
tcp::socket socket(ioc);
acceptor.async_accept(socket, yield[ec]);
if(ec)
{
fail(ec, "accept");
continue;
}
boost::asio::spawn(
acceptor.get_executor(),
std::bind(
&do_coro_session,
websocket::stream<
beast::tcp_stream>(std::move(socket)),
std::placeholders::_1));
}
}
//------------------------------------------------------------------------------
int main(int argc, char* argv[])
{
// Check command line arguments.
if (argc != 4)
{
std::cerr <<
"Usage: websocket-server-fast <address> <starting-port> <threads>\n" <<
"Example:\n"
" websocket-server-fast 0.0.0.0 8080 1\n"
" Connect to:\n"
" starting-port+0 for synchronous,\n"
" starting-port+1 for asynchronous,\n"
" starting-port+2 for coroutine.\n";
return EXIT_FAILURE;
}
auto const address = net::ip::make_address(argv[1]);
auto const port = static_cast<unsigned short>(std::atoi(argv[2]));
auto const threads = std::max<int>(1, std::atoi(argv[3]));
// The io_context is required for all I/O
net::io_context ioc{threads};
// Create sync port
std::thread(beast::bind_front_handler(
&do_sync_listen,
std::ref(ioc),
tcp::endpoint{
address,
static_cast<unsigned short>(port + 0u)}
)).detach();
// Create async port
std::make_shared<async_listener>(
ioc,
tcp::endpoint{
address,
static_cast<unsigned short>(port + 1u)})->run();
// Create coro port
boost::asio::spawn(ioc,
std::bind(
&do_coro_listen,
std::ref(ioc),
tcp::endpoint{
address,
static_cast<unsigned short>(port + 2u)},
std::placeholders::_1));
// Run the I/O service on the requested number of threads
std::vector<std::thread> v;
v.reserve(threads - 1);
for(auto i = threads - 1; i > 0; --i)
v.emplace_back(
[&ioc]
{
ioc.run();
});
ioc.run();
return EXIT_SUCCESS;
}