Skip to main content
Version: 4.x

Google Cloud Pub/Sub 适配器

工作原理

¥How it works

该适配器使用 Google Cloud Pub/Sub 服务 在 Socket.IO 集群的节点之间转发消息。

¥This adapter uses Google Cloud Pub/Sub service to forward messages between the nodes of a Socket.IO cluster.

该适配器的源代码可以找到 此处

¥The source code of this adapter can be found here.

支持的功能

¥Supported features

特性socket.io 版本支持
套接字管理4.0.0:白色复选标记:是(自版本 0.1.0 起)
服务器间通信4.1.0:白色复选标记:是(自版本 0.1.0 起)
广播并致谢4.5.0:白色复选标记:是(自版本 0.1.0 起)
连接状态恢复4.6.0:X:不

安装

¥Installation

npm install @socket.io/gcp-pubsub-adapter

用法

¥Usage

import { PubSub } from "@google-cloud/pubsub";
import { Server } from "socket.io";
import { createAdapter } from "@socket.io/gcp-pubsub-adapter";

const pubsub = new PubSub({
projectId: "your-project-id"
});

const topic = pubsub.topic(topicNameOrId);

const io = new Server({
adapter: createAdapter(topic)
});

// wait for the creation of the pub/sub subscription
await io.of("/").adapter.init();

io.listen(3000);

选项

¥Options

名称描述默认值
subscriptionPrefix要创建的新订阅的前缀。socket.io
subscriptionOptions用于创建订阅的选项。-
heartbeatInterval两次心跳之间的毫秒数。5_000
heartbeatTimeout在我们考虑节点关闭之前没有心跳的毫秒数。10_000

最新版本

¥Latest releases

版本发布日期发行说明差异
0.1.02024 年 3 月link-

完整的变更日志

¥Complete changelog