Skip to content

A C++ library for implementing the WebSocket protocol at a low level

License

Notifications You must be signed in to change notification settings

cppalliance/ws_proto

Repository files navigation

Boost.WS.Proto

Branch master develop

Docs

Documentation

Documentation

GitHub Actions

CI

CI

Drone

Build Status

Build Status

Codecov

codecov

codecov

Boost.WS.Proto

This is currently NOT an official Boost library.

Overview

Boost.WS.Proto is a portable, low-level C++ library which provides containers and algorithms for implementing the WebSocket protocol described in the document The WebSocket Protocol.

Boost.WS.Proto offers these features:

  • Require only C++11

  • Works without exceptions

  • Fast compilation, no templates

  • Strict compliance with rfc7230

Requirements

  • Requires Boost and a compiler supporting at least C++11

  • Aliases for standard types use their Boost equivalents

  • Link to a built static or dynamic Boost library, or use header-only (see below)

  • Supports -fno-exceptions, detected automatically

Header-Only

To eliminate the requirement to link a program to a static or dynamic Boost.WS.Proto library, simply place the following line in exactly one source file in your project.

#include <boost/ws_proto/src.hpp>

Embedded

Boost.WS.Proto works great on embedded devices. It is designed to work without exceptions if desired.

Supported Compilers

Boost.WS.Proto has been tested with the following compilers:

  • clang: 3.8, 4, 5, 6, 7, 8, 9, 10, 11, 12

  • gcc: 5, 6, 7, 8, 9, 10, 11, 12

  • msvc: 14.0, 14.1, 14.2, 14.3

Quality Assurance

The development infrastructure for the library includes these per-commit analyses:

  • Coverage reports

  • Benchmark performance comparisons

  • Compilation and tests on Drone.io, Azure Pipelines, Appveyor

  • Fuzzing using clang-llvm and machine learning

Visual Studio Solution Generation

cmake -G "Visual Studio 17 2022" -A win32 -B bin -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_CHAINLOAD_TOOLCHAIN_FILE="C:/Users/vinnie/src/boost/libs/ws_proto/cmake/toolchains/msvc.cmake"
cmake -G "Visual Studio 17 2022" -A x64 -B bin64 -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_CHAINLOAD_TOOLCHAIN_FILE="C:/Users/vinnie/src/boost/libs/ws_proto/cmake/toolchains/msvc.cmake"

License

Distributed under the Boost Software License, Version 1.0. (See accompanying file [LICENSE_1_0.txt](LICENSE_1_0.txt) or copy at https://www.boost.org/LICENSE_1_0.txt)