Beast # HTTP and WebSocket built on Boost.Asio in C++11 Branch | Build | Coverage | Documentation ------------|---------------|----------------|--------------- [master](https://github.com/vinniefalco/Beast/tree/master) | [![Build Status](https://travis-ci.org/vinniefalco/Beast.svg?branch=master)](https://travis-ci.org/vinniefalco/Beast) [![Build status](https://ci.appveyor.com/api/projects/status/g0llpbvhpjuxjnlw/branch/master?svg=true)](https://ci.appveyor.com/project/vinniefalco/beast/branch/master) | [![codecov](https://codecov.io/gh/vinniefalco/Beast/branch/master/graph/badge.svg)](https://codecov.io/gh/vinniefalco/Beast/branch/master) | [![Documentation](https://img.shields.io/badge/documentation-master-brightgreen.svg)](http://vinniefalco.github.io/beast/) [develop](https://github.com/vinniefalco/Beast/tree/develop) | [![Build Status](https://travis-ci.org/vinniefalco/Beast.svg?branch=develop)](https://travis-ci.org/vinniefalco/Beast) [![Build status](https://ci.appveyor.com/api/projects/status/g0llpbvhpjuxjnlw/branch/develop?svg=true)](https://ci.appveyor.com/project/vinniefalco/beast/branch/develop) | [![codecov](https://codecov.io/gh/vinniefalco/Beast/branch/develop/graph/badge.svg)](https://codecov.io/gh/vinniefalco/Beast/branch/develop) | [![Documentation](https://img.shields.io/badge/documentation-develop-brightgreen.svg)](http://vinniefalco.github.io/stage/beast/develop) ## Contents - [Introduction](#introduction) - [Appearances](#appearances) - [Description](#description) - [Requirements](#requirements) - [Building](#building) - [Usage](#usage) - [Licence](#licence) - [Contact](#contact) - [Contributing](#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 | CppCast 2017 | CppCon 2016 | | ------------ | ----------- | | Vinnie Falco | Beast | ## Description This software is currently in beta: interfaces may change. For recent changes see the [CHANGELOG](CHANGELOG.md). The library has been submitted to the [Boost Library Incubator](http://rrsd.com/blincubator.com/bi_library/beast-2/?gform_post_id=1579) * [Project Site](http://vinniefalco.github.io/) * [Repository](https://github.com/vinniefalco/Beast) * [Project Documentation](http://vinniefalco.github.io/beast/) * [Autobahn.testsuite results](http://vinniefalco.github.io/autobahn/index.html) ## 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:** Optional, for using TLS/Secure sockets. When using Microsoft Visual C++, Visual Studio 2015 Update 3 or later is required. These components are required in order to build the tests and examples: * CMake 3.7.2 or later * Properly configured bjam/b2 ## Building Beast is header-only so there are no libraries to build or link with. To use Beast in your project, simply copy the Beast sources to your project's source tree (alternatively, bring Beast into your Git repository using the `git subtree` or `git submodule` commands). Then, edit your build scripts to add the `include/` directory to the list of paths checked by the C++ compiler when searching for includes. Beast `#include` lines will look like this: ```C++ #include #include ``` To link your program successfully, you'll need to add the Boost.System library to link with. If you use coroutines you'll also need the Boost.Coroutine library. Please visit the Boost documentation for instructions on how to do this for your particular build system. For the examples and tests, Beast provides build scripts for Boost.Build (bjam) and CMake. It is possible to generate Microsoft Visual Studio or Apple Xcode project files using CMake by executing these commands from the root of the repository: ``` mkdir bin cd bin cmake .. # for 32-bit Windows builds cmake -G Xcode .. # for Apple Xcode builds cd .. mkdir bin64 cd bin64 cmake -G"Visual Studio 14 2015 Win64" .. # for 64-bit Windows builds (VS2015) cmake -G"Visual Studio 15 2017 Win64" .. # for 64-bit Windows builds (VS2017) ``` To build with Boost.Build, it is necessary to have the bjam executable in your path. And bjam needs to know how to find the Boost sources. The easiest way to do this is make sure that the version of bjam in your path is the one at the root of the Boost source tree, which is built when running `bootstrap.sh` (or `bootstrap.bat` on Windows). Once bjam is in your path, simply run bjam in the root of the Beast repository to automatically build the required Boost libraries if they are not already built, build the examples, then build and run the unit tests. The files in the repository are laid out thusly: ``` ./ bin/ Create this to hold executables and project files bin64/ Create this to hold 64-bit Windows executables and project files doc/ Source code and scripts for the documentation include/ Add this to your compiler includes beast/ extras/ Additional APIs, may change example/ Self contained example programs test/ Unit tests and benchmarks ``` ## Usage These examples are complete, self-contained programs that you can build and run yourself (they are in the `example` directory). http://vinniefalco.github.io/beast/beast/quick_start.html ## License Distributed under the Boost Software License, Version 1.0. (See accompanying file [LICENSE_1_0.txt](LICENSE_1_0.txt) or copy at http://www.boost.org/LICENSE_1_0.txt) ## Contact Please report issues or questions here: https://github.com/vinniefalco/Beast/issues --- ## Contributing (We Need Your Help!) If you would like to contribute to Beast and help us maintain high quality, consider performing code reviews on active pull requests. Any feedback from users and stakeholders, even simple questions about how things work or why they were done a certain way, carries value and can be used to improve the library. Code review provides these benefits: * Identify bugs * Documentation proof-reading * Adjust interfaces to suit use-cases * Simplify code You can look through the Closed pull requests to get an idea of how reviews are performed. To give a code review just sign in with your GitHub account and then add comments to any open pull requests below, don't be shy!

https://github.com/vinniefalco/Beast/pulls

Here are some resources to learn more about code reviews: * Top 10 Pull Request Review Mistakes * Best Kept Secrets of Peer Code Review (pdf) * 11 Best Practices for Peer Code Review (pdf) * Code Review Checklist – To Perform Effective Code Reviews * Code review guidelines * C++ Core Guidelines * C++ Coding Standards (Sutter & Andrescu) Beast thrives on code reviews and any sort of feedback from users and stakeholders about its interfaces. Even if you just have questions, asking them in the code review or in issues provides valuable information that can be used to improve the library - do not hesitate, no question is insignificant or unimportant! While code reviews are the preferred form of donation, if you simply must donate money to support the library, please do so using Bitcoin sent to this address: 1DaPsDvv6MjFUSnsxXSHzeYKSjzrWrQY7T