Documentation work

test/websocket/CMakeLists.txt

@@ -10,6 +10,7 @@ add_executable (websocket-tests
     ../../extras/beast/unit_test/main.cpp
     websocket_async_echo_server.hpp
     websocket_sync_echo_server.hpp
+    doc_snippets.cpp
     error.cpp
     option.cpp
     rfc6455.cpp

test/websocket/doc_snippets.cpp

@@ -0,0 +1,72 @@
+//
+// Copyright (c) 2013-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)
+//
+
+#include <beast/core.hpp>
+#include <boost/asio.hpp>
+#include <iostream>
+#include <thread>
+
+using namespace beast;
+
+//[ws_snippet_1
+#include <beast/websocket.hpp>
+using namespace beast::websocket;
+//]
+
+namespace doc_ws_snippets {
+
+void fxx() {
+
+boost::asio::io_service ios;
+boost::asio::io_service::work work{ios};
+std::thread t{[&](){ ios.run(); }};
+error_code ec;
+boost::asio::ip::tcp::socket sock{ios};
+
+{
+//[ws_snippet_2
+    stream<boost::asio::ip::tcp::socket> ws{ios};
+//]
+}
+
+{
+//[ws_snippet_3
+    stream<boost::asio::ip::tcp::socket> ws{std::move(sock)};
+//]
+}
+
+{
+//[ws_snippet_4
+    stream<boost::asio::ip::tcp::socket&> ws{sock};
+//]
+
+//[ws_snippet_5
+    ws.next_layer().shutdown(boost::asio::ip::tcp::socket::shutdown_send);
+//]
+}
+
+{
+//[ws_snippet_6
+    std::string const host = "mywebapp.com";
+    boost::asio::ip::tcp::resolver r{ios};
+    stream<boost::asio::ip::tcp::socket> ws{ios};
+    boost::asio::connect(ws.next_layer(),
+        r.resolve(boost::asio::ip::tcp::resolver::query{host, "ws"}));
+//]
+}
+
+{
+//[ws_snippet_7
+    boost::asio::ip::tcp::acceptor acceptor{ios};
+    stream<boost::asio::ip::tcp::socket> ws{acceptor.get_io_service()};
+    acceptor.accept(ws.next_layer());
+//]
+}
+
+} // fxx()
+
+} // doc_ws_snippets

test/websocket/ssl/CMakeLists.txt

@@ -11,6 +11,7 @@ add_executable (websocket-ssl-tests
     ${BEAST_INCLUDES}
     ${EXTRAS_INCLUDES}
     ../../../extras/beast/unit_test/main.cpp
+    doc_snippets.cpp
     websocket_async_ssl_echo_server.hpp
     ssl_server.cpp
 )

test/websocket/ssl/doc_snippets.cpp

@@ -0,0 +1,58 @@
+//
+// Copyright (c) 2013-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)
+//
+
+#include <beast/core.hpp>
+#include <beast/websocket.hpp>
+#include <boost/asio.hpp>
+#include <iostream>
+#include <thread>
+
+using namespace beast;
+using namespace beast::websocket;
+
+//[wss_snippet_1
+#include <beast/websocket/ssl.hpp>
+#include <boost/asio/ssl.hpp>
+//]
+
+namespace doc_wss_snippets {
+
+void fxx() {
+
+boost::asio::io_service ios;
+boost::asio::io_service::work work{ios};
+std::thread t{[&](){ ios.run(); }};
+error_code ec;
+boost::asio::ip::tcp::socket sock{ios};
+
+{
+//[wss_snippet_2
+    boost::asio::ssl::context ctx{boost::asio::ssl::context::sslv23};
+    stream<boost::asio::ssl::stream<boost::asio::ip::tcp::socket>> wss{ios, ctx};
+//]
+}
+
+{
+//[wss_snippet_3
+    boost::asio::ip::tcp::endpoint ep;
+    boost::asio::ssl::context ctx{boost::asio::ssl::context::sslv23};
+    stream<boost::asio::ssl::stream<boost::asio::ip::tcp::socket>> ws{ios, ctx};
+
+    // connect the underlying TCP/IP socket
+    ws.next_layer().next_layer().connect(ep);
+
+    // perform SSL handshake
+    ws.next_layer().handshake(boost::asio::ssl::stream_base::client);
+
+    // perform WebSocket handshake
+    ws.handshake("localhost", "/");
+//]
+}
+
+} // fxx()
+
+} // doc_wss_snippets