boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-07-29 20:37:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation tidy

Browse Source
This commit is contained in:
Vinnie Falco
2017-06-15 01:10:50 -07:00
parent 510092d34b
commit 2bbb8ab8a2
2 changed files with 13 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -13,7 +13,6 @@
## Contents
- [Introduction](#introduction)
- [Audience](audience)
- [Appearances](#appearances)
- [Description](#description)
- [Requirements](#requirements)
@ -25,18 +24,14 @@
## Introduction
Beast is a cross-platform, header-only C++11 library for low-level
HTTP/1 and WebSocket protocol programming
using the consistent asynchronous networking model of Boost.Asio.
Beast is not an HTTP client or HTTP server, but it can be used to
build those things. It is intended to be a foundation for writing
other interoperable libraries by providing HTTP vocabulary types
and algorithms. The provided examples show how clients and servers
might be built.
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:** Interfaces are role-agnostic; build clients, servers, or both.
* **Symmetry:** Algorithms are role-agnostic; build clients, servers, or both.
* **Ease of Use:** Boost.Asio users will immediately understand Beast.
@ -45,16 +40,7 @@ This library is designed for:
* **Performance:** Build applications handling thousands of connections or more.
* **Basis for Further Abstraction.** Components are open-ended and
suited for building higher level libraries.
## Audience
Beast is for network programmers who have some familiarity with
Boost.Asio. In particular, users who wish to write asynchronous programs
with Beast should already know how to use Asio sockets and streams,
and should know how to create concurrent network programs using
Asio callbacks or coroutines.
* **Basis for Further Abstraction.** Components are well-suited for building upon.
## Appearances
@ -76,6 +62,10 @@ The library has been submitted to the
## 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.
@ -146,7 +136,7 @@ The files in the repository are laid out thusly:
include/ Add this to your compiler includes
beast/
extras/ Additional APIs, may change
examples/ Self contained example programs
example/ Self contained example programs
test/ Unit tests and benchmarks
```

4
doc/concept/FieldsReader.qbk
View File

@ -42,7 +42,7 @@ In this table:
[`X(f,v,m)`]
[]
[
The implementatation uses this constructor to indicate
The implementation calls this constructor to indicate
that the fields being serialized form part of an HTTP
request. The lifetime of `f` is guaranteed
to end no earlier than after the `X` is destroyed.
@ -51,7 +51,7 @@ In this table:
[`X(f,v,c)`]
[]
[
The implementatation uses this constructor to indicate
The implementation calls this constructor to indicate
that the fields being serialized form part of an HTTP
response. The lifetime of `f` is guaranteed
to end no earlier than after the `X` is destroyed.