Gateway lock

最后更新:2025-12-11

为什么需要

  • 确保同一主机上每个基础端口只运行一个 Gateway 实例;额外的 Gateway 必须使用独立的配置文件和唯一端口。
  • 在崩溃或 SIGKILL 时不会留下过期的锁文件。
  • 当控制端口已被占用时,快速失败并给出清晰的错误提示。

实现机制

  • Gateway 在启动时立即绑定 WebSocket 监听器(默认 ws://127.0.0.1:18789),使用独占的 TCP 监听器。
  • 如果绑定失败并返回 EADDRINUSE 错误,启动时会抛出 GatewayLockError("another gateway instance is already listening on ws://127.0.0.1:<port>")
  • 操作系统会在进程退出时自动释放监听器,包括崩溃和 SIGKILL 的情况——不需要单独的锁文件或清理步骤。
  • 关闭时,Gateway 会关闭 WebSocket 服务器和底层的 HTTP 服务器,及时释放端口。

错误情况

  • 如果另一个进程占用了端口,启动时会抛出 GatewayLockError("another gateway instance is already listening on ws://127.0.0.1:<port>")
  • 其他绑定失败会显示为 GatewayLockError("failed to bind gateway socket on ws://127.0.0.1:<port>: …")

操作说明

  • 如果端口被其他进程占用,错误提示是一样的;你可以释放端口或用 openclaw gateway --port <port> 选择其他端口。
  • macOS 应用在启动 Gateway 之前仍会维护自己的轻量级 PID 保护;运行时锁由 WebSocket 绑定来强制执行。