feedc0de/boost_beast
1
0
Fork 0
forked from boostorg/beast
Code Pull Requests Activity

Refactor all examples:

Browse Source 
fix #575, fix #604, fix #608, fix #634, fix #712

All examples are rewritten:

* Using Best Practices
* Mostly self-contained
* New examples to complete the feature matrix
* The server-framework example is removed
This commit is contained in:
Vinnie Falco
2017-08-07 20:53:11 -07:00
parent 20a8f7d75b
commit dd71b0f94d
187 changed files with 11759 additions and 7098 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/bench/wsload/wsload.cpp
+26 -18
View File
@@ -7,7 +7,14 @@
// Official repository: https://github.com/boostorg/beast
//
#include <example/common/helpers.hpp>
//------------------------------------------------------------------------------
//
// wsload
//
// Measure the performance of a WebSocket server
//
//------------------------------------------------------------------------------
#include <example/common/session_alloc.hpp>
#include <boost/beast/core.hpp>
@@ -75,6 +82,12 @@ public:
}
};
void
fail(boost::system::error_code ec, char const* what)
{
std::cerr << what << ": " << ec.message() << "\n";
}
class connection
: public std::enable_shared_from_this<connection>
{
@@ -132,20 +145,12 @@ public:
}
private:
void
fail(boost::beast::string_view what, error_code ec)
{
if( ec == asio::error::operation_aborted ||
ec == ws::error::closed)
return;
print(log_, "[", ep_, "] ", what, ": ", ec.message());
}
void
on_connect(error_code ec)
{
if(ec)
return fail("on_connect", ec);
return fail(ec, "on_connect");
ws_.async_handshake(
ep_.address().to_string() + ":" + std::to_string(ep_.port()),
"/",
@@ -159,7 +164,8 @@ private:
on_handshake(error_code ec)
{
if(ec)
return fail("on_connect", ec);
return fail(ec, "handshake");
do_write();
}
@@ -180,9 +186,11 @@ private:
on_write(error_code ec)
{
if(ec)
return fail("on_read", ec);
return fail(ec, "write");
if(messages_--)
return do_read();
ws_.async_close({},
alloc_.wrap(std::bind(
&connection::on_close,
@@ -204,7 +212,8 @@ private:
on_read(error_code ec)
{
if(ec)
return fail("on_read", ec);
return fail(ec, "read");
++count_;
bytes_ += buffer_.size();
buffer_.consume(buffer_.size());
@@ -215,7 +224,7 @@ private:
on_close(error_code ec)
{
if(ec)
return fail("on_close", ec);
return fail(ec, "close");
}
};
@@ -264,8 +273,7 @@ main(int argc, char** argv)
if(argc != 8)
{
std::cerr <<
"Usage: " << argv[0] <<
" <address> <port> <trials> <messages> <workers> <threads> <compression:0|1>";
"Usage: bench-wsload <address> <port> <trials> <messages> <workers> <threads> <compression:0|1>";
return EXIT_FAILURE;
}
@@ -316,7 +324,7 @@ main(int argc, char** argv)
}
catch(std::exception const& e)
{
std::cerr << "Exception: " << e.what() << std::endl;
std::cerr << "Error: " << e.what() << std::endl;
return EXIT_FAILURE;
}
test/example/CMakeLists.txt
-1
View File
@@ -8,4 +8,3 @@
#
add_subdirectory (common)
add_subdirectory (server)
test/example/Jamfile
-1
View File
@@ -9,7 +9,6 @@
alias run-tests :
common//run-tests
server//run-tests
;
alias fat-tests ;
test/example/common/CMakeLists.txt
+2 -2
View File
@@ -17,8 +17,8 @@ add_executable (tests-example-common
${COMMON_INCLUDES}
Jamfile
detect_ssl.cpp
mime_types.cpp
rfc7231.cpp
root_certificates.cpp
server_certificate.cpp
session_alloc.cpp
ssl_stream.cpp
write_msg.cpp
test/example/common/Jamfile
+2 -2
View File
@@ -9,8 +9,8 @@
local SOURCES =
detect_ssl.cpp
mime_types.cpp
rfc7231.cpp
root_certificates.cpp
server_certificate.cpp
session_alloc.cpp
ssl_stream.cpp
write_msg.cpp
test/example/common/mime_types.cpp → test/example/common/root_certificates.cpp
+1 -1
View File
@@ -8,5 +8,5 @@
//
// Test that header file is self-contained.
#include "example/common/mime_types.hpp"
#include "example/common/root_certificates.hpp"
test/example/common/rfc7231.cpp → test/example/common/server_certificate.cpp
+1 -1
View File
@@ -8,5 +8,5 @@
//
// Test that header file is self-contained.
#include "example/common/rfc7231.hpp"
#include "example/common/server_certificate.hpp"
test/example/server/CMakeLists.txt
-37
View File
@@ -1,37 +0,0 @@
#
# 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(example/server-framework framework)
GroupSources(example/common common)
GroupSources(test/extras/include/boost/beast extras)
GroupSources(include/boost/beast beast)
GroupSources(test/example/server "/")
add_executable (tests-example-server
${BOOST_BEAST_INCLUDES}
${COMMON_INCLUDES}
${SERVER_INCLUDES}
${TEST_MAIN}
Jamfile
file_service.cpp
framework.cpp
http_async_port.cpp
http_base.cpp
http_sync_port.cpp
https_ports.cpp
multi_port.cpp
server.cpp
service_list.cpp
ssl_certificate
tests.cpp
ws_async_port.cpp
ws_sync_port.cpp
ws_upgrade_service.cpp
wss_ports.cpp
)
test/example/server/Jamfile
-39
View File
@@ -1,39 +0,0 @@
#
# 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
#
local SOURCES =
file_service.cpp
framework.cpp
http_async_port.cpp
http_base.cpp
http_sync_port.cpp
https_ports.cpp
multi_port.cpp
server.cpp
service_list.cpp
ssl_certificate.cpp
#tests.cpp
ws_async_port.cpp
ws_sync_port.cpp
ws_upgrade_service.cpp
wss_ports.cpp
;
local RUN_TESTS ;
for local f in $(SOURCES)
{
RUN_TESTS += [ compile $(f) ] ;
}
alias run-tests : $(RUN_TESTS) ;
alias fat-tests : run-tests ;
explicit fat-tests ;
test/example/server/file_service.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/file_service.hpp"
test/example/server/framework.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/framework.hpp"
test/example/server/http_async_port.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/http_async_port.hpp"
test/example/server/http_base.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/http_base.hpp"
test/example/server/http_sync_port.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/http_sync_port.hpp"
test/example/server/https_ports.cpp
-15
View File
@@ -1,15 +0,0 @@
//
// 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
//
#if BOOST_BEAST_USE_OPENSSL
// Test that header file is self-contained.
#include "example/server-framework/https_ports.hpp"
#endif
test/example/server/multi_port.cpp
-16
View File
@@ -1,16 +0,0 @@
//
// 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
//
#if BOOST_BEAST_USE_OPENSSL
// Test that header file is self-contained.
#include "example/server-framework/multi_port.hpp"
#endif
test/example/server/server.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/server.hpp"
test/example/server/service_list.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/service_list.hpp"
test/example/server/ssl_certificate.cpp
-15
View File
@@ -1,15 +0,0 @@
//
// 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
//
#if BOOST_BEAST_USE_OPENSSL
// Test that header file is self-contained.
#include "example/server-framework/ssl_certificate.hpp"
#endif
test/example/server/tests.cpp
-320
View File
@@ -1,320 +0,0 @@
//
// 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
//
#include "example/server-framework/http_sync_port.hpp"
#include "example/server-framework/http_async_port.hpp"
#include "example/server-framework/ws_sync_port.hpp"
#include "example/server-framework/ws_async_port.hpp"
#include "example/server-framework/ws_upgrade_service.hpp"
#if BOOST_BEAST_USE_OPENSSL
# include "example/server-framework/https_ports.hpp"
# include "example/server-framework/multi_port.hpp"
# include "example/server-framework/ssl_certificate.hpp"
# include "example/server-framework/wss_ports.hpp"
#endif
#include <boost/beast/websocket.hpp>
#include <boost/beast/test/yield_to.hpp>
#include <boost/beast/unit_test/suite.hpp>
namespace boost {
namespace beast {
namespace websocket {
class server_test
: public beast::unit_test::suite
, public test::enable_yield_to
{
public:
static unsigned short constexpr port_num = 6000;
class set_ws_options
{
beast::websocket::permessage_deflate pmd_;
public:
set_ws_options(beast::websocket::permessage_deflate const& pmd)
: pmd_(pmd)
{
}
template<class NextLayer>
void
operator()(beast::websocket::stream<NextLayer>& ws) const
{
ws.auto_fragment(false);
ws.set_option(pmd_);
ws.read_message_max(64 * 1024 * 1024);
}
};
set_ws_options
get_ws_options()
{
beast::websocket::permessage_deflate pmd;
pmd.client_enable = true;
pmd.server_enable = true;
pmd.compLevel = 3;
return set_ws_options{pmd};
}
template<class Stream>
void
doOptions(Stream& stream, error_code& ec)
{
http::request<http::empty_body> req;
req.version = 11;
req.method(http::verb::options);
req.target("*");
req.set(http::field::user_agent, "test");
req.set(http::field::connection, "close");
http::write(stream, req, ec);
if(! BEAST_EXPECTS(
ec == http::error::end_of_stream,
ec.message()))
return;
beast::flat_buffer b;
http::response<http::string_body> res;
http::read(stream, b, res, ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
}
template<class NextLayer>
void
doHello(stream<NextLayer>& ws, error_code& ec)
{
ws.handshake("localhost", "/", ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
ws.write(boost::asio::buffer(std::string("Hello, world!")), ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
beast::multi_buffer b;
ws.read(b, ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
ws.close(beast::websocket::close_code::normal, ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
}
void
httpClient(framework::endpoint_type const& ep)
{
error_code ec;
boost::asio::ip::tcp::socket con{ios_};
con.connect(ep, ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
doOptions(con, ec);
}
void
wsClient(framework::endpoint_type const& ep)
{
error_code ec;
stream<boost::asio::ip::tcp::socket> ws{ios_};
ws.next_layer().connect(ep, ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
doHello(ws, ec);
}
void
testPlain()
{
using namespace framework;
// ws sync
{
error_code ec;
server instance;
auto const ep1 = endpoint_type{
address_type::from_string("127.0.0.1"), port_num};
auto const wsp = instance.make_port<ws_sync_port>(
ec, ep1, instance, log, get_ws_options());
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
auto const ep2 = endpoint_type{
address_type::from_string("127.0.0.1"),
static_cast<unsigned short>(port_num + 1)};
auto const sp = instance.make_port<
http_sync_port<ws_upgrade_service<ws_sync_port>>>(
ec, ep2, instance, log);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
sp->template init<0>(ec, *wsp);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
wsClient(ep1);
wsClient(ep2);
httpClient(ep2);
}
// ws async
{
error_code ec;
server instance;
auto const ep1 = endpoint_type{
address_type::from_string("127.0.0.1"), port_num};
auto const wsp = instance.make_port<ws_async_port>(
ec, ep1, instance, log, get_ws_options());
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
auto const ep2 = endpoint_type{
address_type::from_string("127.0.0.1"),
static_cast<unsigned short>(port_num + 1)};
auto const sp = instance.make_port<
http_async_port<ws_upgrade_service<ws_async_port>>>(
ec, ep2, instance, log);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
sp->template init<0>(ec, *wsp);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
wsClient(ep1);
wsClient(ep2);
httpClient(ep2);
}
}
#if BOOST_BEAST_USE_OPENSSL
//
// OpenSSL enabled ports
//
void
httpsClient(framework::endpoint_type const& ep,
boost::asio::ssl::context& ctx)
{
error_code ec;
boost::asio::ssl::stream<boost::asio::ip::tcp::socket> con{ios_, ctx};
con.next_layer().connect(ep, ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
con.handshake(
boost::asio::ssl::stream_base::client, ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
doOptions(con, ec);
if(ec)
return;
con.shutdown(ec);
// VFALCO No idea why we get eof in the normal case
if(ec == boost::asio::error::eof)
ec.assign(0, ec.category());
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
}
void
wssClient(framework::endpoint_type const& ep,
boost::asio::ssl::context& ctx)
{
error_code ec;
stream<boost::asio::ssl::stream<boost::asio::ip::tcp::socket>> wss{ios_, ctx};
wss.next_layer().next_layer().connect(ep, ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
wss.next_layer().handshake(
boost::asio::ssl::stream_base::client, ec);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
doHello(wss, ec);
}
void
testSSL()
{
using namespace framework;
ssl_certificate cert;
// wss sync
{
error_code ec;
server instance;
auto const ep1 = endpoint_type{
address_type::from_string("127.0.0.1"), port_num};
auto const wsp = instance.make_port<wss_sync_port>(
ec, ep1, instance, log, cert.get(), get_ws_options());
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
auto const ep2 = endpoint_type{
address_type::from_string("127.0.0.1"),
static_cast<unsigned short>(port_num + 1)};
auto const sp = instance.make_port<
https_sync_port<ws_upgrade_service<wss_sync_port>>>(
ec, ep2, instance, log, cert.get());
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
sp->template init<0>(ec, *wsp);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
wssClient(ep1, cert.get());
wssClient(ep2, cert.get());
httpsClient(ep2, cert.get());
}
// wss async
{
error_code ec;
server instance;
auto const ep1 = endpoint_type{
address_type::from_string("127.0.0.1"), port_num};
auto const wsp = instance.make_port<wss_async_port>(
ec, ep1, instance, log, cert.get(), get_ws_options());
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
auto const ep2 = endpoint_type{
address_type::from_string("127.0.0.1"),
static_cast<unsigned short>(port_num + 1)};
auto const sp = instance.make_port<
https_async_port<ws_upgrade_service<wss_async_port>>>(
ec, ep2, instance, log, cert.get());
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
sp->template init<0>(ec, *wsp);
if(! BEAST_EXPECTS(! ec, ec.message()))
return;
wssClient(ep1, cert.get());
wssClient(ep2, cert.get());
httpsClient(ep2, cert.get());
}
}
#endif
void
run() override
{
testPlain();
#if BOOST_BEAST_USE_OPENSSL
testSSL();
#endif
}
};
BEAST_DEFINE_TESTSUITE(beast,websocket,server);
} // websocket
} // beast
} // boost
test/example/server/ws_async_port.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/ws_async_port.hpp"
test/example/server/ws_sync_port.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/ws_sync_port.hpp"
test/example/server/ws_upgrade_service.cpp
-12
View File
@@ -1,12 +0,0 @@
//
// 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
//
// Test that header file is self-contained.
#include "example/server-framework/ws_upgrade_service.hpp"
test/example/server/wss_ports.cpp
-15
View File
@@ -1,15 +0,0 @@
//
// 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
//
#if BOOST_BEAST_USE_OPENSSL
// Test that header file is self-contained.
#include "example/server-framework/wss_ports.hpp"
#endif