Doc work

test/doc/websocket_2_handshaking.cpp

@@ -0,0 +1,154 @@
+//
+// 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
+//
+
+#include <boost/beast/_experimental/unit_test/suite.hpp>
+
+#ifdef BOOST_MSVC
+#pragma warning(push)
+#pragma warning(disable: 4459) // declaration hides global declaration
+#endif
+
+#include <boost/beast.hpp>
+#include <boost/beast/ssl.hpp>
+#include <boost/asio.hpp>
+#include <boost/asio/ssl.hpp>
+
+namespace {
+
+#include "websocket_common.ipp"
+
+void
+snippets()
+{
+    {
+    //[code_websocket_2_1
+
+        stream<tcp_stream> ws(ioc);
+        net::ip::tcp::resolver resolver(ioc);
+        get_lowest_layer(ws).connect(resolver.resolve("www.example.com", "ws"));
+
+        // Do the websocket handshake in the client role, on the connected stream.
+        // The implementation only uses the Host parameter to set the HTTP "Host" field,
+        // it does not perform any DNS lookup. That must be done first, as shown above.
+
+        ws.handshake(
+            "www.example.com",  // The Host field
+            "/"                 // The request-target
+        );
+
+    //]
+    }
+
+    {
+
+    stream<tcp_stream> ws(ioc);
+
+    {
+    //[code_websocket_2_2
+
+        // This variable will receive the HTTP response from the server
+        response_type res;
+
+        // Perform the websocket handshake in the client role.
+        // On success, `res` will hold the complete HTTP response received.
+
+        ws.handshake(
+            res,                // Receives the HTTP response
+            "www.example.com",  // The Host field
+            "/"                 // The request-target
+        );
+
+    //]
+    }
+
+    //--------------------------------------------------------------------------
+
+    {
+    //[code_websocket_2_3
+
+        // Perform the websocket handshake in the server role.
+        // The stream must already be connected to the peer.
+
+        ws.accept();
+
+    //]
+    }
+
+    {
+    //[code_websocket_2_4
+
+        // This buffer is required for reading HTTP messages
+        flat_buffer buffer;
+
+        // Read into our buffer until we reach the end of the HTTP request.
+        // No parsing takes place here, we are just accumulating data.
+        // We use beast::dynamic_buffer_ref to pass a lightweight, movable
+        // reference to our buffer, because Networking expects to take
+        // ownership, while Beast algorithms only use a reference.
+
+        net::read_until(sock, dynamic_buffer_ref(buffer), "\r\n\r\n");
+
+        // Now accept the connection, using the buffered data.
+        ws.accept(buffer.data());
+
+    //]
+    }
+
+    }
+
+    {
+    //[code_websocket_2_5
+
+        // This buffer is required for reading HTTP messages
+        flat_buffer buffer;
+
+        // Read the HTTP request ourselves
+        http::request<http::string_body> req;
+        http::read(sock, buffer, req);
+
+        // See if its a WebSocket upgrade request
+        if(websocket::is_upgrade(req))
+        {
+            // Construct the stream, transferring ownership of the socket
+            stream<tcp_stream> ws(std::move(sock));
+
+            // Clients SHOULD NOT begin sending WebSocket
+            // frames until the server has provided a response.
+            BOOST_ASSERT(buffer.size() == 0);
+
+            // Accept the upgrade request
+            ws.accept(req);
+        }
+        else
+        {
+            // Its not a WebSocket upgrade, so
+            // handle it like a normal HTTP request.
+        }
+
+    //]
+    }
+}
+
+struct websocket_2_test
+    : public boost::beast::unit_test::suite
+{
+    void
+    run() override
+    {
+        BEAST_EXPECT(&snippets);
+    }
+};
+
+BEAST_DEFINE_TESTSUITE(beast,doc,websocket_2);
+
+} // (anon)
+
+#ifdef BOOST_MSVC
+#pragma warning(pop)
+#endif