uWebSockets README

The project's README from github.com/uNetworking/uWebSockets. As one markdown file: README.md.


Simple, secure1 & standards compliant2 web server for the most demanding3 of applications. Read more...



:closed_lock_with_key: Optimized security

Being meticulously optimized for speed and memory footprint, µWebSockets is fast enough to do encrypted TLS 1.3 messaging quicker than most alternative servers can do even unencrypted, cleartext messaging3.

Furthermore, we partake in Google's OSS-Fuzz with a ~95% daily fuzzing coverage4 with no sanitizer issues. LGTM scores us flawless A+ from having zero CodeQL alerts and we compile with pedantic warning levels.

:arrow_forward: Rapid scripting

µWebSockets is written entirely in C & C++ but has a seamless integration for Node.js backends. This allows for rapid scripting of powerful apps, using widespread competence. See µWebSockets.js.

:crossed_swords: Battle proven

We've been fully standards compliant with a perfect Autobahn|Testsuite score since 20162. µWebSockets powers many of the biggest crypto exchanges in the world, handling trade volumes of multiple billions of USD every day. If you trade crypto, chances are you do so via µWebSockets.

:battery: Batteries included

Designed around a convenient URL router with wildcard & parameter support - paired with efficient pub/sub features for WebSockets. µWebSockets should be the obvious, complete starting point for any real-time web project with high demands.

Start building your Http & WebSocket apps in no time; read the user manual and see examples. You can browse our TypeDoc for a quick overview.

/* One app per thread; spawn as many as you have CPU-cores and let uWS share the listening port */
uWS::SSLApp({

    /* These are the most common options, fullchain and key. See uSockets for more options. */
    .cert_file_name = "cert.pem",
    .key_file_name = "key.pem"
    
}).get("/hello/:name", [](auto *res, auto *req) {

    /* You can efficiently stream huge files too */
    res->writeStatus("200 OK")
       ->writeHeader("Content-Type", "text/html; charset=utf-8")
       ->write("<h1>Hello ")
       ->write(req->getParameter("name"))
       ->end("!</h1>");
    
}).ws<UserData>("/*", {

    /* Just a few of the available handlers */
    .open = [](auto *ws) {
        ws->subscribe("oh_interesting_subject");
    },
    .message = [](auto *ws, std::string_view message, uWS::OpCode opCode) {
        ws->send(message, opCode);
    }
    
}).listen(9001, [](auto *listenSocket) {

    if (listenSocket) {
        std::cout << "Listening on port " << 9001 << std::endl;
    } else {
        std::cout << "Failed to load certs or to bind to port" << std::endl;
    }
    
}).run();

:briefcase: Commercially supported

uNetworking AB is a Swedish consulting & contracting company dealing with anything related to µWebSockets; development, support and customer success.

Don't hesitate sending a mail if you're building something large, in need of advice or having other business inquiries in mind. We'll figure out what's best for both parties and make sure you're not falling into common pitfalls.

Special thanks to BitMEX, Bitfinex, Google, Coinbase, Bitwyre, AppDrag and deepstreamHub for allowing the project itself to thrive on GitHub since 2016 - this project would not be possible without these beautiful companies.

:wrench: Customizable architecture

µWebSockets builds on µSockets, a foundation library implementing eventing, networking and cryptography in three different layers. Every layer has multiple implementations and you control the compiled composition with flags. There are currently five event-loop integrations; libuv, ASIO, GCD and raw epoll/kqueue.

In a nutshell:

See µSockets for an up-to-date list of flags and a more detailed explanation.

:handshake: Permissively licensed

Intellectual property, all rights reserved.

Where such explicit notice is given, source code is licensed Apache License 2.0 which is a permissive OSI-approved license with very few limitations. Modified "forks" should be of nothing but licensed source code, and be made available under another product name. If you're uncertain about any of this, please ask before assuming.

uWebSockets (uNetworking/uWebSockets)

Searching Database…

19K ·GitHub
UWebSockets
Что это такое?μWebSockets — это простой, безопасный и соответствующий стандартам веб-сервер для требовательных приложений, реализованный как библиотека на C++ — настолько оптимизированный по скорости и потреблению памяти, что его шифрованные сообщения по TLS 1.3 работают быстрее, чем открытый текст у большинства серверов.
Это сервер, который я разворачиваю, или библиотека, которую я использую в своём коде?Это библиотека, которую вы компилируете в собственное приложение, а не готовый демон. Она построена на μSockets — базовой библиотеке, реализующей события, сети и криптографию в виде трёх отдельных слоёв.
Как её запустить?Соберите входящие в комплект примеры с помощью make, выбирая бэкенды через флаги компиляции: 'WITHWOLFSSL=1 WITHLIBUV=1 make examples' для WolfSSL плюс libuv или 'WITHOPENSSL=1 make examples' для OpenSSL и нативного событийного цикла ядра.
Он работает только на Linux или ещё на macOS и Windows?Он кроссплатформенный: слой событийного цикла предлагает сырой epoll и kqueue для Linux, BSD-систем и macOS, GCD от Apple, а также переносимые сборки на libuv и ASIO, которые покрывают и Windows.
Ей можно пользоваться бесплатно, в том числе в коммерческих проектах?Исходный код распространяется по Apache 2.0 — разрешающей лицензии, одобренной OSI и имеющей очень мало ограничений, — но в README есть примечание об интеллектуальной собственности: форки должны состоять исключительно из лицензированного исходного кода и выпускаться под другим названием продукта.
Помимо WebSockets, что ещё входит в комплект?Согласно темам репозитория, в него входят HTTP-роутер, обмен сообщениями по модели publish/subscribe и поддержка протокола proxy-protocol, так что один процесс может одновременно обслуживать HTTP-эндпоинты и трафик WebSocket в реальном времени.
Он проверен в бою или это экспериментальный проект?Проверен в бою: проект успешно развивается на GitHub с 2016 года, а в README благодарят BitMEX, Bitfinex, Google, Coinbase, Bitwyre, AppDrag и deepstreamHub — криптобиржи и крупные технологические компании используют его в продакшене.
Есть ли платная поддержка, если я строю на нём что-то большое?Да. uNetworking — шведская консалтинговая компания, работающая по контрактам, — занимается разработкой, поддержкой и работой с клиентами вокруг μWebSockets и приглашает написать себя всем, кто строит что-то масштабное или хочет получить совет, как избежать типичных ошибок.
Где посмотреть полный список флагов сборки?README отсылает к отдельному репозиторию μSockets — там приведён актуальный список флагов и более подробное объяснение того, как сочетать слои.
What are similar projects?cpp-httplib, pingora, nginx, echo, tornado, fasthttp, lua-nginx-module, h2o
Which topics is it in?pubsub, websockets, web-server, router, realtime, tls, high-performance, http, encryption, cpp, c++, backend
Creator
uNetworking
Size
6.1 MB
Stars
19K
Updated
CommitOct 05Releasev20.80.0Sep 03
Age
10y
Commits · 90 Days