开源项目 `hashrocket/ws` 使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00218/article/details/141214172

开源项目 `hashrocket/ws` 使用教程

wswebsocket command line tool项目地址:https://gitcode.com/gh_mirrors/ws3/ws

1. 项目的目录结构及介绍

hashrocket/ws/
├── bin/
│   └── ws
├── lib/
│   ├── ws.rb
│   └── ws/
│       ├── client.rb
│       ├── server.rb
│       └── version.rb
├── spec/
│   ├── ws_spec.rb
│   └── spec_helper.rb
├── .gitignore
├── .rspec
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── README.md
└── ws.gemspec

bin/: 包含可执行文件 ws，用于启动服务器或客户端。
lib/: 包含项目的核心代码，包括 ws.rb 和子目录 ws 下的文件。
- ws.rb: 主文件，加载其他模块。
- client.rb: 客户端实现。
- server.rb: 服务器实现。
- version.rb: 版本信息。
spec/: 包含测试文件。
.gitignore: Git 忽略文件配置。
.rspec: RSpec 配置文件。
Gemfile: 依赖管理文件。
Gemfile.lock: 依赖锁定文件。
LICENSE: 许可证文件。
README.md: 项目说明文档。
ws.gemspec: 项目规格文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 ws。这个文件是一个可执行脚本，用于启动 WebSocket 服务器或客户端。

#!/usr/bin/env ruby

require 'ws'

if ARGV.empty?
  puts "Usage: ws [server|client]"
  exit 1
end

command = ARGV.shift
case command
when 'server'
  WS::Server.run
when 'client'
  WS::Client.run
else
  puts "Unknown command: #{command}"
  exit 1
end

该脚本首先加载 ws 库。
根据命令行参数 (server 或 client) 启动相应的服务。

3. 项目的配置文件介绍

项目没有显式的配置文件，但可以通过环境变量或命令行参数进行配置。例如，可以通过设置环境变量 WS_HOST 和 WS_PORT 来指定服务器的主机和端口。

module WS
  class Server
    def self.run
      host = ENV['WS_HOST'] || 'localhost'
      port = ENV['WS_PORT'] || 8080
      # 启动服务器代码
    end
  end
end