boostorg / beast

HTTP and WebSocket built on Boost.Asio in C++11 Branch | Linux / Windows | Coverage | Documentation | Matrix | ----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| master | | | | | develop | | | | | Contents • Introduction • Appearances • Description • Requirements • Git Branches • Building • Usage • License • Contact • Contributing Introduction Beast is a C++ header-only library serving as a foundation for writing interoperable networking libraries by providing **low-level HTTP/1, WebSocket, and networking protocol** vocabulary types and algorithms using the consistent asynchronous model of Boost.Asio. This library is designed for: • **Symmetry:** Algorithms are role-agnostic; build clients, servers, or both. • **Ease of Use:** Boost.Asio users will immediately understand Beast. • **Flexibility:** Users make the important decisions such as buffer or thread management. • **Performance:** Build applications handling thousands of connections or more. • **Basis for Further Abstraction.** Components are well-suited for building upon. Appearances | CppCon 2018 | Bishop Fox 2018 | | ------------ | ------------ | | | | | CppCon 2017 | CppCast 2017 | CppCon 2016 | | ------------ | ------------ | ----------- | | | | | Description This software is in its first official release. Interfaces may change in response to user feedback. For recent changes see the CHANGELOG. • Official Site • Documentation (master branch) • Autobahn|Testsuite WebSocket Results Requirements This library is for programmers familiar with Boost.Asio. Users who wish to use asynchronous interfaces should already know how to create concurrent network programs using callbacks or coroutines. • **C++11:** Robust support for most language features. • **Boost:** Boost.Asio and some other parts of Boost. • **OpenSSL:** Required for using TLS/Secure sockets and examples/tests When using Microsoft Visual C++, Visual Studio 2017 or later is required. One of these components is required in order to build the tests and examples: • Properly configured bjam/b2 • CMake 3.5.1 or later (Windows only) Building Beast is header-only. To use it just add the necessary line to your source files, like this: If you use coroutines you'll need to link with the Boost.Coroutine library. Please visit the Boost documentation for instructions on how to do this for your particular build system. GitHub To use the latest official release of Beast, simply obtain the latest Boost distribution and follow the instructions for integrating it into your development environment. If you wish to build the examples and tests, or if you wish to preview upcoming changes and features, it is suggested to clone the "Boost superproject" and work with Beast "in-tree" (meaning, the libs/beast subdirectory of the superproject). The official repository contains the following branches: • **master** This holds the most recent snapshot with code that is known to be stable. • **develop** This holds the most recent snapshot. It may contain unstable code. Each of these branches requires a corresponding Boost branch and all of its subprojects. For example, if you wish to use the **master** branch version of Beast, you should clone the Boost superproject, switch to the **master** branch in the superproject and acquire all the Boost libraries corresponding to that branch including Beast. To clone the superproject locally, and switch into the main project's directory use: "bjam" is used to build Beast and the Boost libraries. On a non-Windows system use this command to build bjam: From a Windows command line, build bjam using this command: Building tests and examples Building tests and examples requires OpenSSL installed. If OpenSSL is installed in a non-system location, you will need to copy the user-config.jam file into your home directory and set the environment variable to the path that contains an installation of OpenSSL. Ubuntu/Debian If installed into a system directory, OpenSSL will be automatically found and used. Windows Replace in the following code snippets with the path you installed vcpkg to. Examples assume a 32-bit build, if you build a 64-bit version replace with in the path. • Using vcpkg and CMD: • Using vcpkg and PowerShell: • Using vcpkg and bash: Mac OS Using brew: Make sure the bjam tool (also called "b2") is available in the path your shell uses to find executables. The Beast project is located in "libs/beast" relative to the directory containing the Boot superproject. To build the Beast tests, examples, and documentation use these commands: Additional instructions for configuring, using, and building libraries in superproject may be found in the Boost Wiki. Visual Studio CMake may be used to generate a very nice Visual Studio solution and a set of Visual Studio project files using these commands: The files in the repository are laid out thusly: Usage These examples are complete, self-contained programs that you can build and run yourself (they are in the directory). https://www.boost.org/doc/libs/develop/libs/beast/doc/html/beast/quick_start.html License Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt) Contact Please report issues or questions here: https://github.com/boostorg/beast/issues --- Contributing (We Need Your Help!) If you would like to contr…