Temptationx / uWebSockets

Tiny WebSockets

µWS ("microWS") is one of the most lightweight, efficient & scalable WebSocket & HTTP server implementations available. It features an easy-to-use, fully async object-oriented interface and scales to millions of connections using only a fraction of memory compared to the competition. While performance and scalability are two of our top priorities, we consider security, stability and standards compliance paramount. License is zlib/libpng (very permissive & suits commercial applications).

• Autobahn tests all pass.
• One million WebSockets require ~111mb of user space memory (104 bytes per WebSocket).
• Single-threaded throughput of up to 5 million HTTP req/sec or 20 million WebSocket echoes/sec.
• Linux, OS X, Windows & Node.js support.
• Runs with raw epoll, libuv or ASIO (C++17-ready).
• Valgrind & AddressSanitizer clean.
• Permessage-deflate, SSL/TLS support & integrates with foreign HTTP(S) servers.
• Multi-core friendly & optionally thread-safe via compiler flag UWS_THREADSAFE.

WARNING µWS is not affiliated with, represented by, substituted with, or in any shape or form encouraged to be used via Socket.IO, SocketCluster, Primus, Engine.IO, Feathers or any similar wrapper module. No such wrapper project properly represent or portray µWS and should not be confused with, or misrepresented as being µWS. Severe, fundamental and deep-rooted performance catastrophes haunt every mentioned wrapper project and utterly ruin any chance of a proper speed-up. Everything from 5x to a staggering 100x overhead to µWS has been measured for mentioned wrapper projects. If you are not directly using µWS then you should absolutely not assume any of its benefits.

• Don't be this guy

Simple & modern

The interface has been designed for simplicity and only requires you to write a few lines of code to get a working server:

#include <uWS/uWS.h>

int main() {
    uWS::Hub h;

    h.onMessage([](uWS::WebSocket<uWS::SERVER> *ws, char *message, size_t length, uWS::OpCode opCode) {
        ws->send(message, length, opCode);
    });

    h.onHttpRequest([](uWS::HttpResponse *res, uWS::HttpRequest req, char *data, size_t length, size_t remainingBytes) {
        res->end(const char *, size_t);
    });

    if (h.listen(3000)) {
        h.run();
    }
}

Get the sources of the uws.chat server here. Learn from the tests here. Also do check the Wiki pages.

Not your average server

µWS was designed to perform well across the board, not just in one specific dimension. With excellent memory usage paired with high throughput it outscales Socket.IO by 180x (Socket.IO 2 by 120x).

Benchmarks are run with default settings in all libraries, except for ws which is run with the native performance addons. Read more about the benchmarks here.

Perfect for WebRTC

Distributed WebRTC networks typically employ WebSockets for peer signalling. Since every single peer in the entire distributed network requires a persistent connection to the signalling server at all times, only a scalable WebSocket server will do.

Getting started

Sources are provided as-is, without any personal support or help. There is no issue tracker due to the extensive spam of nonsense bug reports, duplicates and otherwise narcissistic demands of personal support. If you find an issue you want fixed, chances are you need to fix it yourself and send me a PR. Please try and understand though, this library sees multiple thousands of downloads every single day. This means the chance of your "this library is completely broken" bug report being valid becomes close to 0%. Please act accordingly.

Dependencies

First of all you need to install the required dependencies. This is very easily done with a good open source package manager like Homebrew for OS X, vcpkg for Windows or your native Linux package manager.

• OpenSSL 1.x.x
• zlib 1.x
• libuv 1.3+ or Boost.Asio 1.x (both optional on Linux)

If you wish to integrate with a specific event-loop you can define USE_ASIO or USE_LIBUV as a global compilation flag and then link to respective libraries. USE_EPOLL is default on Linux while other systems default to USE_LIBUV.

• Fedora: sudo dnf install openssl-devel zlib-devel
• Homebrew: brew install openssl zlib libuv
• Vcpkg: vcpkg install openssl zlib libuv and/or vcpkg install openssl:x64-windows zlib:x64-windows libuv:x64-windows

Compilation

OS X & Linux

• make
• sudo make install (or as you wish)

Windows

• Compile VC++.vcxproj with Visual C++ Community Edition 2015 or later.