这是一个供库作者和高级用例使用的低级 API。

启动服务器（Bun.listen()）

要使用 Bun.listen 启动 TCP 服务器：

Bun.listen({
  hostname: "localhost",
  port: 8080,
  socket: {
    data(socket, data) {}, // 从客户端接收的消息
    open(socket) {}, // 套接字打开
    close(socket, error) {}, // 套接字关闭
    drain(socket) {}, // 套接字准备好接收更多数据
    error(socket, error) {}, // 错误处理程序
  },
});

为速度设计的 API

在 Bun 中，一组处理程序每个服务器声明一次，而不是像 Node.js EventEmitters 或 Web 标准 WebSocket API 那样为每个套接字分配回调。

Bun.listen({
  hostname: "localhost",
  port: 8080,
  socket: {
    open(socket) {},
    data(socket, data) {},
    drain(socket) {},
    close(socket, error) {},
    error(socket, error) {},
  },
});

对于性能敏感的服务器，为每个套接字分配监听器会导致显著的垃圾回收器压力并增加内存使用。相比之下，Bun 只为每个事件分配一个处理程序函数并在所有套接字之间共享。这是一个小的优化，但会累积。

上下文数据可以在 open 处理程序中附加到套接字。

type SocketData = { sessionId: string };

Bun.listen<SocketData>({
  hostname: "localhost",
  port: 8080,
  socket: {
    data(socket, data) {
      socket.write(`${socket.data.sessionId}: ack`); 
    },
    open(socket) {
      socket.data = { sessionId: "abcd" }; 
    },
  },
});

要启用 TLS，传递包含 key 和 cert 字段的 tls 对象。

Bun.listen({
  hostname: "localhost",
  port: 8080,
  socket: {
    data(socket, data) {},
  },
  tls: {
    // 可以是字符串、BunFile、TypedArray、Buffer 或它们的数组
    key: Bun.file("./key.pem"), 
    cert: Bun.file("./cert.pem"), 
  },
});

key 和 cert 字段期望你的 TLS 密钥和证书的_内容_。这可以是字符串、BunFile、TypedArray 或 Buffer。

Bun.listen({
  // ...
  tls: {
    key: Bun.file("./key.pem"), // BunFile
    key: fs.readFileSync("./key.pem"), // Buffer
    key: fs.readFileSync("./key.pem", "utf8"), // 字符串
    key: [Bun.file("./key1.pem"), Bun.file("./key2.pem")], // 上述数组
  },
});

Bun.listen 的结果是符合 TCPSocket 接口的服务器。

const server = Bun.listen({
  /* 配置 */
});

// 停止监听
// 参数决定是否关闭活动连接
server.stop(true);

// 即使服务器仍在监听也允许 Bun 进程退出
server.unref();

---

创建连接（Bun.connect()）

使用 Bun.connect 连接到 TCP 服务器。使用 hostname 和 port 指定要连接的服务器。TCP 客户端可以定义与 Bun.listen 相同的一组处理程序，外加几个客户端特定的处理程序。

// 客户端
const socket = await Bun.connect({
  hostname: "localhost",
  port: 8080,

  socket: {
    data(socket, data) {},
    open(socket) {},
    close(socket, error) {},
    drain(socket) {},
    error(socket, error) {},

    // 客户端特定的处理程序
    connectError(socket, error) {}, // 连接失败
    end(socket) {}, // 服务器关闭连接
    timeout(socket) {}, // 连接超时
  },
});

要要求 TLS，指定 tls: true。

// 客户端
const socket = await Bun.connect({
  // ... 配置
  tls: true, 
});

---

热重新加载

TCP 服务器和套接字都可以使用新的处理程序进行热重新加载。

const server = Bun.listen({
  /* 配置 */
});

// 为所有活动服务器端套接字重新加载处理程序
server.reload({
  socket: {
    data() {
      // 新的 'data' 处理程序
    },
  },
});

const socket = await Bun.connect({
  /* 配置 */
});

socket.reload({
  data() {
    // 新的 'data' 处理程序
  },
});

---

缓冲

目前，Bun 中的 TCP 套接字不缓冲数据。对于性能敏感的代码，仔细考虑缓冲很重要。例如，这个：

socket.write("h");
socket.write("e");
socket.write("l");
socket.write("l");
socket.write("o");

...性能明显低于这个：

socket.write("hello");

为了暂时简化这个问题，考虑使用 Bun 的 ArrayBufferSink 和 {stream: true} 选项：

import { ArrayBufferSink } from "bun";

const sink = new ArrayBufferSink();
sink.start({
  stream: true, 
  highWaterMark: 1024,
});

sink.write("h");
sink.write("e");
sink.write("l");
sink.write("l");
sink.write("o");

queueMicrotask(() => {
  const data = sink.flush();
  const wrote = socket.write(data);
  if (wrote < data.byteLength) {
    // 如果套接字已满，将其放回 sink
    sink.write(data.subarray(wrote));
  }
});

NOTE

**Corking**

支持 corking 正在计划中，但与此同时，必须使用 drain 处理程序手动管理背压。