uWebSockets 技术文档

uWebSockets 技术文档

uWebSockets 项目地址: https://gitcode.com/gh_mirrors/uwe/uWebSockets

安装指南

对于Node.js用户

要使用uWebSockets.js（Node.js版本），首先确保您已安装Node.js。然后通过npm进行安装：

npm install uws

对于C++项目

确保您的环境中已经配置好了C++编译器以及支持WebSocket的库。对于uWebSockets库，你需要从源码编译它。首先克隆仓库：

git clone https://github.com/uNetworking/uWebSockets.git
cd uWebSockets

然后选择性地设置编译标志（如启用WolfSSL或OpenSSL）并构建示例：

# 使用OpenSSL和libuv
WITH_OPENSSL=1 WITH_LIBUV=1 make examples

# 或者使用其他配置

构建完成后，相关库文件和头文件即可用于您的C++项目。

项目的使用说明

Node.js示例

在Node.js环境下，一个简单的服务器创建如下：

const uws = require('uws');

let app = uws.App()
  .get('/hello/:name', (res, req) => {
    res.end(`Hello ${req.param('name')}!`);
  })
  .listen(9000, (listenSocket) => {
    if (listenSocket) {
      console.log('Server is listening on port 9000.');
    } else {
      console.error('Failed to start the server.');
    }
  });

C++示例

对于C++，以下代码展示了基本的HTTP和WebSocket服务端实现：

#include <uWebSockets.h>

int main() {
  uWS::SSLApp({{"cert.pem", "key.pem"}}).get("/hello/:name", 
   [](uWS::HttpResponse<false> *res, uWS::HttpRequest *req) {
      res->writeHead(200, {{"Content-Type", "text/plain"}});
      res->end("Hello " + req->getQueryParameter("name") + "!");
    }).ws<PERMESSAGE_DEFLATE>("/*", {
    .maxPayloadLength = 16 * 1024,
    .upgrade = [](uWS::HttpResponse<false> *res, uWS::HttpRequest *req, bool *allow) {
      *allow = true; // Default allow unless you specify otherwise
    },
    .message = [](uWS::WebSocket<uWS::SERVER> *ws, char *message, size_t length, uWS::OpCode opCode) {
      ws->send(message, length, opCode);
    },
    .drain = [](uWS::WebSocket<uWS::SERVER> *ws) {
      // Handle backpressure here
    },
    .close = [](uWS::WebSocket<uWS::SERVER> *ws, int code, char *message, size_t length) {
      // Clean-up logic goes here
    },
    .ping = [] (uWS::WebSocket<uWS::SERVER> *ws) {},
    .pong = [] (uWS::WebSocket<uWS::SERVER> *ws) {}
  }).listen(9001, [](uWS::listen_socket *listenSocket) {
    if (listenSocket) {
      std::cout << "Listening on port 9001." << std::endl;
    } else {
      std::cerr << "Failed to listen on port 9001." << std::endl;
    }
  }).run();

  return 0;
}

项目API使用文档

请参考uWebSockets.js生成的TypeDoc获取详细的API文档。这些文档涵盖了JavaScript接口的每个方法和属性，以及它们在WebSocket通信中的角色。对于C++部分，查阅项目内的注释和示例程序是理解API的最佳途径，因为官方未提供详细的在线API文档。

项目安装方式（重申）

• Node.js: npm install uws
• C++: 克隆项目源码，并通过Makefile和适当选项编译（例如，使用make examples）。

以上就是uWebSockets的基本使用教程和技术细节。无论是快速搭建WebSocket服务还是打造高性能的HTTP应用，uWebSockets都是一个强大且灵活的选择。

uWebSockets 项目地址: https://gitcode.com/gh_mirrors/uwe/uWebSockets