awaitable examples.

Closes #2104.
This commit is contained in:
Klemens Morgenstern
2022-10-30 00:13:54 +08:00
committed by Klemens Morgenstern
parent 1fc340713c
commit 09bfca1fa1
26 changed files with 2293 additions and 0 deletions
+1
View File
@@ -8,6 +8,7 @@
#
add_subdirectory (async)
add_subdirectory (awaitable)
add_subdirectory (coro)
add_subdirectory (sync)
+1
View File
@@ -8,6 +8,7 @@
#
build-project async ;
build-project awaitable ;
build-project coro ;
build-project sync ;
@@ -0,0 +1,23 @@
#
# Copyright (c) 2016-2017 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
#
GroupSources(include/boost/beast beast)
GroupSources(example/websocket/client/awaitable "/")
add_executable (websocket-client-awaitable
${BOOST_BEAST_FILES}
Jamfile
websocket_client_awaitable.cpp
)
target_link_libraries(websocket-client-awaitable
lib-asio
lib-beast)
set_property(TARGET websocket-client-awaitable PROPERTY FOLDER "example-websocket-client")
@@ -0,0 +1,15 @@
#
# Copyright (c) 2016-2017 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
#
exe websocket-client-awaitable :
websocket_client_awaitable.cpp
:
<variant>coverage:<build>no
<variant>ubasan:<build>no
;
@@ -0,0 +1,162 @@
//
// Copyright (c) 2022 Klemens D. Morgenstern (klemens dot morgenstern at gmx dot net)
//
// 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 client, coroutine
//
//------------------------------------------------------------------------------
#include <boost/beast/core.hpp>
#include <boost/beast/websocket.hpp>
#include <cstdlib>
#include <functional>
#include <iostream>
#include <string>
#include <boost/asio/awaitable.hpp>
#include <boost/asio/co_spawn.hpp>
#include <boost/asio/detached.hpp>
#include <boost/asio/use_awaitable.hpp>
#if defined(BOOST_ASIO_HAS_CO_AWAIT)
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 << what << ": " << ec.message() << "\n";
}
// Sends a WebSocket message and prints the response
net::awaitable<void>
do_session(
std::string host,
std::string port,
std::string text)
{
// These objects perform our I/O
auto resolver = net::use_awaitable.as_default_on(
tcp::resolver(co_await net::this_coro::executor));
auto ws = net::use_awaitable.as_default_on(
websocket::stream<beast::tcp_stream>(co_await net::this_coro::executor));
// Look up the domain name
auto const results = co_await resolver.async_resolve(host, port);
// Set a timeout on the operation
beast::get_lowest_layer(ws).expires_after(std::chrono::seconds(30));
// Make the connection on the IP address we get from a lookup
auto ep = co_await beast::get_lowest_layer(ws).async_connect(results);
// Update the host_ string. This will provide the value of the
// Host HTTP header during the WebSocket handshake.
// See https://tools.ietf.org/html/rfc7230#section-5.4
host += ':' + std::to_string(ep.port());
// Turn off the timeout on the tcp_stream, because
// the websocket stream has its own timeout system.
beast::get_lowest_layer(ws).expires_never();
// Set suggested timeout settings for the websocket
ws.set_option(
websocket::stream_base::timeout::suggested(
beast::role_type::client));
// Set a decorator to change the User-Agent of the handshake
ws.set_option(websocket::stream_base::decorator(
[](websocket::request_type& req)
{
req.set(http::field::user_agent,
std::string(BOOST_BEAST_VERSION_STRING) +
" websocket-client-coro");
}));
// Perform the websocket handshake
co_await ws.async_handshake(host, "/");
// Send the message
co_await ws.async_write(net::buffer(std::string(text)));
// This buffer will hold the incoming message
beast::flat_buffer buffer;
// Read a message into our buffer
co_await ws.async_read(buffer);
// Close the WebSocket connection
co_await ws.async_close(websocket::close_code::normal);
// If we get here then the connection is closed gracefully
// The make_printable() function helps print a ConstBufferSequence
std::cout << beast::make_printable(buffer.data()) << std::endl;
}
//------------------------------------------------------------------------------
int main(int argc, char** argv)
{
// Check command line arguments.
if(argc != 4)
{
std::cerr <<
"Usage: websocket-client-awaitable <host> <port> <text>\n" <<
"Example:\n" <<
" websocket-client-awaitable echo.websocket.org 80 \"Hello, world!\"\n";
return EXIT_FAILURE;
}
auto const 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;
// Launch the asynchronous operation
net::co_spawn(ioc,
do_session(host, port, text),
[](std::exception_ptr e)
{
if (e)
try
{
std::rethrow_exception(e);
}
catch(std::exception & e)
{
std::cerr << "Error: " << e.what() << "\n";
}
});
// Run the I/O service. The call will return when
// the socket is closed.
ioc.run();
return EXIT_SUCCESS;
}
#else
int main(int, char * [])
{
std::printf("awaitables require C++20\n");
return 1;
}
#endif
+1
View File
@@ -8,6 +8,7 @@
#
add_subdirectory (async)
add_subdirectory (awaitable)
add_subdirectory (chat-multi)
add_subdirectory (coro)
add_subdirectory (fast)
+1
View File
@@ -8,6 +8,7 @@
#
build-project async ;
build-project awaitable ;
build-project chat-multi ;
build-project coro ;
build-project fast ;
@@ -0,0 +1,23 @@
#
# Copyright (c) 2016-2017 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
#
GroupSources(include/boost/beast beast)
GroupSources(example/websocket/server/awaitable "/")
add_executable (websocket-server-awaitable
${BOOST_BEAST_FILES}
Jamfile
websocket_server_awaitable.cpp
)
target_link_libraries(websocket-server-awaitable
lib-asio
lib-beast)
set_property(TARGET websocket-server-awaitable PROPERTY FOLDER "example-websocket-server")
@@ -0,0 +1,15 @@
#
# Copyright (c) 2016-2017 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
#
exe websocket-server-awaitable :
websocket_server_awaitable.cpp
:
<variant>coverage:<build>no
<variant>ubasan:<build>no
;
@@ -0,0 +1,181 @@
//
// Copyright (c) 2022 Klemens D. Morgenstern (klemens dot morgenstern at gmx dot net)
//
// 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, coroutine
//
//------------------------------------------------------------------------------
#include <boost/beast/core.hpp>
#include <boost/beast/websocket.hpp>
#include <boost/asio/awaitable.hpp>
#include <boost/asio/co_spawn.hpp>
#include <boost/asio/detached.hpp>
#include <boost/asio/use_awaitable.hpp>
#include <algorithm>
#include <cstdlib>
#include <functional>
#include <iostream>
#include <memory>
#include <string>
#include <thread>
#include <vector>
#if defined(BOOST_ASIO_HAS_CO_AWAIT)
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>
using stream = websocket::stream<
typename beast::tcp_stream::rebind_executor<
typename net::use_awaitable_t<>::executor_with_default<net::any_io_executor>>::other>;
//------------------------------------------------------------------------------
// Echoes back all received WebSocket messages
net::awaitable<void>
do_session(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) +
" websocket-server-coro");
}));
// Accept the websocket handshake
co_await ws.async_accept();
for(;;)
try {
// This buffer will hold the incoming message
beast::flat_buffer buffer;
// Read a message
co_await ws.async_read(buffer);
// Echo the message back
ws.text(ws.got_text());
co_await ws.async_write(buffer.data());
}
catch(boost::system::system_error & se)
{
if (se.code() != websocket::error::closed)
throw;
}
}
//------------------------------------------------------------------------------
// Accepts incoming connections and launches the sessions
net::awaitable<void>
do_listen(
tcp::endpoint endpoint)
{
// Open the acceptor
auto acceptor = net::use_awaitable.as_default_on(tcp::acceptor(co_await net::this_coro::executor));
acceptor.open(endpoint.protocol());
// Allow address reuse
acceptor.set_option(net::socket_base::reuse_address(true));
// Bind to the server address
acceptor.bind(endpoint);
// Start listening for connections
acceptor.listen(net::socket_base::max_listen_connections);
for(;;)
boost::asio::co_spawn(
acceptor.get_executor(),
do_session(stream(co_await acceptor.async_accept())),
[](std::exception_ptr e)
{
try
{
std::rethrow_exception(e);
}
catch (std::exception &e) {
std::cerr << "Error in session: " << e.what() << "\n";
}
});
}
int main(int argc, char* argv[])
{
// Check command line arguments.
if (argc != 4)
{
std::cerr <<
"Usage: websocket-server-awaitable <address> <port> <threads>\n" <<
"Example:\n" <<
" websocket-server-awaitable 0.0.0.0 8080 1\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);
// Spawn a listening port
boost::asio::co_spawn(
ioc,
do_listen(tcp::endpoint{address, port}),
[](std::exception_ptr e)
{
if (e)
try
{
std::rethrow_exception(e);
}
catch(std::exception & e)
{
std::cerr << "Error: " << e.what() << "\n";
}
});
// 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;
}
#else
int main(int, char * [])
{
std::printf("awaitables require C++20\n");
return 1;
}
#endif