Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/corvusoft/restbed
Corvusoft's Restbed framework brings asynchronous RESTful functionality to C++14 applications.
https://github.com/corvusoft/restbed
async-programming asynchronous comet cpp http http-server http2 push restful restful-api restful-webservices server-sent-events ssl-support tls-support websocket websocket-api websocket-library
Last synced: 23 days ago
JSON representation
Corvusoft's Restbed framework brings asynchronous RESTful functionality to C++14 applications.
- Host: GitHub
- URL: https://github.com/corvusoft/restbed
- Owner: Corvusoft
- License: other
- Created: 2015-06-19T15:07:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T09:30:05.000Z (2 months ago)
- Last Synced: 2024-10-03T12:21:49.039Z (about 1 month ago)
- Topics: async-programming, asynchronous, comet, cpp, http, http-server, http2, push, restful, restful-api, restful-webservices, server-sent-events, ssl-support, tls-support, websocket, websocket-api, websocket-library
- Language: C++
- Homepage: http://www.corvusoft.co.uk
- Size: 3.91 MB
- Stars: 1,922
- Watchers: 102
- Forks: 380
- Open Issues: 82
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Restbed [](https://ci.appveyor.com/project/Corvusoft/restbed/branch/master)
=============================================================================================================================
---
Restbed is a comprehensive and consistent programming model for building applications that require seamless and secure communication over HTTP, with the ability to model a range of business processes, designed to target mobile, tablet, desktop and embedded production environments.
> It's akin to embedding NGINX into your companies own product line. -- Solutions Architect, Bellrock Technology
Features
--------
| Feature | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [WebSockets](https://github.com/Corvusoft/restbed/blob/master/documentation/example/WEB_SOCKET.md) | Full-duplex communication channels over a single TCP connection. |
| [Server-Sent Events](https://github.com/Corvusoft/restbed/blob/master/documentation/example/SERVER_SIDE_EVENTS.md) | Server-Sent Events enables efficient server-to-client streaming of text-based event data—e.g., real-time notifications or updates generated on the server. |
| [Comet](https://github.com/Corvusoft/restbed/blob/master/documentation/example/HTTP_PERSISTENT_CONNECTION.md) | Long polling model to allow long-held HTTP requests for pushing data from the server to client. |
| [SSL/TLS](https://github.com/Corvusoft/restbed/blob/master/documentation/example/HTTPS_SERVICE.md) | Secure over the wire communication allowing you to transmit private data online. |
| [Session Management](https://github.com/Corvusoft/restbed/blob/master/documentation/example/SESSION_MANAGER.md) | Create custom HTTP session persistence and management logic. |
| [HTTP Pipelining](https://github.com/Corvusoft/restbed/blob/master/documentation/example/HTTP_PIPELINING.md) | A technique allowing multiple HTTP requests to be sent on a single TCP connection without waiting for the corresponding responses. |
| [Path Parameters](https://github.com/Corvusoft/restbed/blob/master/documentation/example/PATH_PARAMETERS.md) | Annotate URIs with custom path parameters such as resource keys, revisions, etc... |
| Query Parameters | Automated query parameter parsing. |
| [Header Filters](https://github.com/Corvusoft/restbed/blob/master/documentation/example/RESOURCE_FILTERING.md) | Filter incoming HTTP requests by headers. |
| [Logging](https://github.com/Corvusoft/restbed/blob/master/documentation/example/LOGGING.md) | Customise how and where log entries are created. |
| [Multi-Path Resources](https://github.com/Corvusoft/restbed/blob/master/documentation/example/MULTIPATH_RESOURCES.md) | Give a resource multiple paths for improved readability. |
| [Customisable Methods](https://github.com/Corvusoft/restbed/blob/master/documentation/example/CUSTOM_HTTP_METHOD.md) | Add your own custom HTTP methods. |
| [Compression](https://github.com/Corvusoft/restbed/blob/master/documentation/example/COMPRESSION.md) | Adaptability to address any form of compression GZip, Deflate, etc... |
| Encoding | Adaptability to address any form of encoding UTF-32, ASCII, etc... |
| [Rules Engine](https://github.com/Corvusoft/restbed/blob/master/documentation/example/RULES_ENGINE.md) | Reduce complexity by processing incoming requests with readable units of code. |
| [HTTP](https://github.com/Corvusoft/restbed/blob/master/documentation/example/HTTP_CLIENT.md)/[HTTPS](https://github.com/Corvusoft/restbed/blob/master/example/https_client/source/verify_none.cpp) | Built in client capabilities with optional SSL peer certificate verification. Deprecated |
| IPv4/IPv6 | Internet Protocol Version 4/6 Network Support. |
| Architecture | Asynchronous [single](https://github.com/Corvusoft/restbed/blob/master/example/publishing_resources/source/example.cpp) or [multi-threaded](https://github.com/Corvusoft/restbed/blob/master/documentation/example/MULTITHREADED_SERVICE.md) architecture, capable of addressing the C10K problem. |
| Converters | Built-in Path, Query, and Header conversions for primary data-types. |
| [Authentication](https://github.com/Corvusoft/restbed/blob/master/documentation/example/DIGEST_AUTHENTICATION.md) | Separate Service and/or Resource level authentication. |
| [Error Handling](https://github.com/Corvusoft/restbed/blob/master/documentation/example/ERROR_HANDLING.md) | Separate Service and/or Resource level error handling. |
| [Address Binding](https://github.com/Corvusoft/restbed/blob/master/documentation/example/ADDRESS_BINDING.md) | Bind HTTP and/or HTTPS services to separate IP addresses. |
| [Signal Handling](https://github.com/Corvusoft/restbed/blob/master/documentation/example/SIGNAL_HANDLING.md) | Capture OS generated process signals. |
| [Documentation](https://github.com/Corvusoft/restbed/tree/master/documentation) | High-quality documentation covering the architecture and API. |
| Compliance | Flexibility to address HTTP 1.0/1.1+ compliance. |
| Mature | Secure, Stable, and extensively tested since 2013. |
| Community | Active, vibrant and energetic open source community. |
| Support | Commercial support is available from [Corvusoft](http://www.corvusoft.co.uk). |
Example
-------
```C++
#include
#include
#include
using namespace std;
using namespace restbed;
void post_method_handler( const shared_ptr< Session > session )
{
const auto request = session->get_request( );
int content_length = request->get_header( "Content-Length", 0 );
session->fetch( content_length, [ ]( const shared_ptr< Session > session, const Bytes & body )
{
fprintf( stdout, "%.*s\n", ( int ) body.size( ), body.data( ) );
session->close( OK, "Hello, World!", { { "Content-Length", "13" } } );
} );
}
int main( const int, const char** )
{
auto resource = make_shared< Resource >( );
resource->set_path( "/resource" );
resource->set_method_handler( "POST", post_method_handler );
auto settings = make_shared< Settings >( );
settings->set_port( 1984 );
settings->set_default_header( "Connection", "close" );
Service service;
service.publish( resource );
service.start( settings );
return EXIT_SUCCESS;
}
```
More in-depth examples can be found [here](https://github.com/Corvusoft/restbed/tree/master/documentation/example). To see Restbed used in anger, please visit Corvusoft's [RestQ](https://github.com/corvusoft/restq) project.
License
-------
© 2013-2020 Corvusoft Limited, United Kingdom. All rights reserved.
The Restbed framework is dual licensed; See [LICENSE](LICENSE) for full details.
Support
-------
Please contact [email protected], for support and licensing options including bespoke software development, testing, design consultation, training, mentoring and code review.
Please submit all enhancements, proposals, and defects via the [issue](http://github.com/corvusoft/restbed/issues) tracker; Alternatively ask a question on [StackOverflow](http://stackoverflow.com/questions/ask) tagged [#restbed](http://stackoverflow.com/questions/tagged/restbed).
Build
-----
```bash
git clone --recursive https://github.com/corvusoft/restbed.git
mkdir restbed/build
cd restbed/build
cmake [-DBUILD_SSL=NO] [-DBUILD_TESTS=NO] ..
make install
make test
```
You will now find all required components installed in the distribution sub-folder.
Build Options
-------------
| Option | Description | Default |
| :------------------- | :----------------------------------------- | :------: |
| BUILD_SSL | Enable SSL/TLS support. | Enabled |
| BUILD_IPC | Enable Unix domain sockets. | Disabled |
| BUILD_TESTS | Build project test suites. | Enabled |
| BUILD_DEVEL_PACKAGE | Install headers into CMAKE_INSTALL_PREFIX. | Enabled |
| BUILD_SHARED_LIBRARY | Produce a shared build of restbed. | Enabled |
| BUILD_STATIC_LIBRARY | Produce a static build of restbed. | Enabled |
Windows Build Instructions
--------------------------
Prerequisites: Visual Studio 2022, CMake, GIT, Perl.
Using the x64 Native Tools Command Prompt begin by, if required, building OpenSSL.
```cmd
git clone --recursive https://github.com/corvusoft/restbed.git
cd restbed\dependency\openssl
perl Configure [no-]shared
nmake
nmake test
```
If you selected to use the default OpenSSL build (shared), you'll need to include the installation path in your environment.
```cmd
set PATH=restbed\dependency\openssl;%PATH%
```
If you selected to use the static OpenSSL build (no-shared), you'll need to include additional dependencies when linking your application code; See [OpenSSL project](https://github.com/openssl/openssl/pull/1062/files) for futher details.
```cmd
target_link_libraries( my_microservice restbed-static.lib ws2_32.lib advapi32.lib crypt32.lib gdi32.lib user32.lib )
```
Now proceed with the following Restbed build instructions.
```cmd
mkdir restbed\build
cd restbed\build
cmake -G "Visual Studio 17 2022" [-DBUILD_SSL=NO] [-DBUILD_TESTS=NO] ..
cmake --build . --target ALL_BUILD --config Release
ctest
```
For Microsoft Visual Studio 14 2015 instructions, and further details, please see feature [#17](https://github.com/Corvusoft/restbed/issues/17).
Building Restbed - Using vcpkg
------------------------------
You can download and install restbed using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:
``` shell
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install restbed
```
The restbed port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
Documentation
-------------
This codebase is intended to be as self documenting as possible. We have supplied many [examples](https://github.com/Corvusoft/restbed/tree/master/documentation/example) and [test suites](https://github.com/corvusoft/restbed/tree/master/test) to help aid developers.
You can locate the latest design and API documentation [here](https://github.com/Corvusoft/restbed/tree/master/documentation).
Minimum Requirements
--------------------
| Resource | Requirement |
|:--------:|:-----------------------------------------------:|
| Compiler | C++14 compliant or above |
| OS | BSD, Linux, Mac OSX, Windows, Raspbian |
Road Map
--------
| Milestone | Feature | Status |
|:-----------------------------------------------------------------------------------:|:---------------------------------------:|:-----------:|
| 0.0 | Asynchronous HTTP Service | complete |
| 1.0 | HTTP 1.0 Compliance | complete |
| 2.0 | HTTP 1.1 Compliance | complete |
| 2.5 | Secure Socket Layer | complete |
| 2.5 | Simultaneous Network Ports (HTTP/HTTPS) | complete |
| 3.0 | Rules Engine | complete |
| [3.5](https://github.com/Corvusoft/restbed/issues?utf8=%E2%9C%93&q=milestone%3A3.5) | Schedule Tasks on Service run-loop | complete |
| [3.5](https://github.com/Corvusoft/restbed/issues?utf8=%E2%9C%93&q=milestone%3A3.5) | Multi-Threaded service capability | complete |
| [3.5](https://github.com/Corvusoft/restbed/issues?utf8=%E2%9C%93&q=milestone%3A3.5) | Bind Service to specific Address | complete |
| [3.5](https://github.com/Corvusoft/restbed/issues?utf8=%E2%9C%93&q=milestone%3A3.5) | Session Management | complete |
| [4.0](https://github.com/Corvusoft/restbed/milestones/4.0) | HTTP Client | complete |
| [4.0](https://github.com/Corvusoft/restbed/milestones/4.0) | Signal Handling | complete |
| [4.5](https://github.com/Corvusoft/restbed/milestones/4.5) | API Documentation | complete |
| [4.5](https://github.com/Corvusoft/restbed/milestones/4.5) | Web Sockets | complete |
| [5.0](https://github.com/Corvusoft/restbed/milestones/5.0) | Client-side SSL certificates | development |
| [5.0](https://github.com/Corvusoft/restbed/milestones/5.0) | Resource Caching | development |
| [5.0](https://github.com/Corvusoft/restbed/milestones/5.0) | Runtime Modifications | development |
| [5.0](https://github.com/Corvusoft/restbed/milestones/5.0) | HTTP 2 compliance | development |
| [5.0](https://github.com/Corvusoft/restbed/milestones/5.0) | Refactor, Reduce, Reuse | active |
Contact
-------
| Method | Description |
|:--------------------------------------------|:--------------------------------------------|
| [Twitter](http://www.twitter.com/corvusoft) | Tweet us your questions & feature requests. |
| [email protected] | Support related queries. |
| [email protected] | Sale related queries. |