# Beast **Repository Path**: mirrors_Ceph/Beast ## Basic Information - **Project Name**: Beast - **Description**: HTTP and WebSocket implementations built on Boost.Asio in C++11 - **Primary Language**: Unknown - **License**: BSL-1.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-10-29 - **Last Updated**: 2025-09-14 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README Boost.Beast Title # HTTP and WebSocket built on Boost.Asio in C++11 Branch | Linux/OSX | Windows | Coverage | Documentation | Matrix ------------|-----------|---------|----------|---------------|-------- [master](https://github.com/boostorg/beast/tree/master) | [![Build Status](https://travis-ci.org/boostorg/beast.svg?branch=master)](https://travis-ci.org/boostorg/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/boostorg/Beast/branch/master/graph/badge.svg)](https://codecov.io/gh/boostorg/beast/branch/master) | [![Documentation](https://img.shields.io/badge/documentation-master-brightgreen.svg)](http://www.boost.org/doc/libs/master/libs/beast/doc/html/beast.html) | [![Matrix](https://img.shields.io/badge/matrix-master-brightgreen.svg)](http://www.boost.org/development/tests/master/developer/beast.html) [develop](https://github.com/boostorg/beast/tree/develop) | [![Build Status](https://travis-ci.org/boostorg/beast.svg?branch=develop)](https://travis-ci.org/boostorg/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/boostorg/Beast/branch/develop/graph/badge.svg)](https://codecov.io/gh/boostorg/beast/branch/develop) | [![Documentation](https://img.shields.io/badge/documentation-develop-brightgreen.svg)](http://www.boost.org/doc/libs/develop/libs/beast/) | [![Matrix](https://img.shields.io/badge/matrix-develop-brightgreen.svg)](http://www.boost.org/development/tests/develop/developer/beast.html) ## Contents - [Introduction](#introduction) - [Appearances](#appearances) - [Description](#description) - [Requirements](#requirements) - [Building](#building) - [Usage](#usage) - [License](#license) - [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). As of July 20th, this library has been ACCEPTED into Boost without conditions. The first official release of Beast will appear in Boost 1.66.0, due in December. * [Official Site](https://github.com/boostorg/beast) * [Documentation](http://www.boost.org/doc/libs/develop/libs/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. One of these components is required in order to build the tests and examples: * Properly configured bjam/b2 * CMake 3.7.2 or later (Windows only) ## Building Beast is header-only. To use it just add the necessary `#include` line to your source files, like this: ```C++ #include ``` To build your program successfully, you'll need to add the Boost.System library to link with. If you use coroutines you'll also 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. For the examples and tests, Beast provides build scripts for Boost.Build (bjam) and CMake (Windows). It is possible to generate Microsoft Visual Studio project files using CMake by executing these commands from the root of the repository: ``` mkdir bin cd bin cmake .. # for 32-bit Windows 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) ``` 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/ Where the header files live extras/ Additional APIs, may change example/ Self contained example programs meta/ Metadata for Boost integration scripts/ Small scripts used with CI systems test/ Unit tests ``` ## Usage These examples are complete, self-contained programs that you can build and run yourself (they are in the `example` directory). http://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](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/boostorg/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/boostorg/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!