uWebsockets.js for FreeBSD
Go to file
Björn Busse 51e39cfd94 Add support for FreeBSD
Tested on FreeBSD 13
with boringssl 123eaaef26abc278f53ae338e9c758eb01c70b08
2022-02-03 18:52:19 +01:00
.github/workflows Update c-cpp.yml 2021-10-24 22:52:00 +02:00
docs change websocket publish to return boolean as the uws method publish returns boolean (#641) 2021-12-07 14:46:30 +01:00
examples An example for Rate limit (#566) 2021-06-29 20:38:24 +02:00
misc Add files via upload 2021-04-13 18:12:41 +02:00
src Use latin1 in getHeader 2022-01-19 03:08:15 +01:00
tests Pass Autobahn again 2019-10-09 20:30:50 +02:00
uWebSockets@40742a7c63 Update uWS to 20.9.0 2022-01-09 18:57:44 +01:00
.gitattributes Don't include js files in language stats 2019-04-10 12:42:00 +02:00
.gitmodules Add uWebSockets submodule 2018-11-04 00:11:12 +01:00
LICENSE Apache 2.0 license 2018-11-15 16:01:49 +01:00
Makefile Add upload_host helper target 2021-10-24 23:10:33 +02:00
README.md Update README.md 2021-10-31 00:29:24 +02:00
build.c Add support for FreeBSD 2022-02-03 18:52:19 +01:00

README.md


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

Language grade: C/C++



Simple performance

µWebSockets.js is an HTTP/WebSocket server for Node.js that runs 8.5x that of Fastify and at least 10x that of Socket.IO. It comes with both router and pub/sub support and is suited for extraordinary performance needs. Browse the documentation and see the main repo. There are tons of examples but here's the gist of it all:

/* Non-SSL is simply App() */
require('uWebSockets.js').SSLApp({

  /* There are more SSL options, cut for brevity */
  key_file_name: 'misc/key.pem',
  cert_file_name: 'misc/cert.pem',
  
}).ws('/*', {

  /* There are many common helper features */
  idleTimeout: 30,
  maxBackpressure: 1024,
  maxPayloadLength: 512,
  compression: DEDICATED_COMPRESSOR_3KB,

  /* For brevity we skip the other events (upgrade, open, ping, pong, close) */
  message: (ws, message, isBinary) => {
    /* You can do app.publish('sensors/home/temperature', '22C') kind of pub/sub as well */
    
    /* Here we echo the message back, using compression if available */
    let ok = ws.send(message, isBinary, true);
  }
  
}).get('/*', (res, req) => {

  /* It does Http as well */
  res.writeStatus('200 OK').writeHeader('IsExample', 'Yes').end('Hello there!');
  
}).listen(9001, (listenSocket) => {

  if (listenSocket) {
    console.log('Listening to port 9001');
  }
  
});

💪 Unfair advantage

Being written in native code directly targeting the Linux kernel makes it way faster than any JavaScript implementation.

Low latencies are key to customer satisfaction and your competitive edge. Run low latency services at a lower cost.

⚔️ 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.

📦 Easily installed

We recommend, for simplicity installing with yarn add uWebSockets.js@uNetworking/uWebSockets.js#v20.3.0 or any such release.

Being an open source project, you are of course perfectly free to choose other ways of installation as you might prefer.

💼 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 stepping into one of the many common pitfalls.

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

⚙️ Gear up

If performance is of utter importance, you don't necessarily have to use JavaScript/Node.js but could write apps in C++ using µWebSockets directly. It works exactly the same way, and will offer the best performance for those highly demanding applications where scripting won't do.

🤝 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.