EM-WebSocket 项目教程

EM-WebSocket 项目教程

em-websocketEventMachine based WebSocket server项目地址:https://gitcode.com/gh_mirrors/em/em-websocket

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

EM-WebSocket 项目的目录结构如下：

em-websocket/
├── examples/
│   ├── echo.rb
│   ├── multicast.rb
│   └── ...
├── lib/
│   ├── em-websocket/
│   │   ├── handler.rb
│   │   ├── message.rb
│   │   └── ...
│   └── em-websocket.rb
├── spec/
│   ├── em-websocket_spec.rb
│   └── ...
├── .gitignore
├── CHANGELOG.rdoc
├── Gemfile
├── LICENSE
├── README.md
├── Rakefile
└── em-websocket.gemspec

目录介绍

• examples/: 包含一些示例代码，如 echo.rb 和 multicast.rb，展示了如何使用 EM-WebSocket 进行基本的 WebSocket 通信。
• lib/: 包含项目的核心代码，其中 em-websocket/ 目录下是具体的实现文件，如 handler.rb 和 message.rb。
• spec/: 包含测试文件，用于项目的单元测试。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.rdoc: 项目变更日志。
• Gemfile: 用于定义项目的依赖关系。
• LICENSE: 项目的许可证。
• README.md: 项目的主文档，包含项目的基本介绍和使用说明。
• Rakefile: 用于定义项目的构建任务。
• em-websocket.gemspec: 项目的 gem 配置文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 examples/ 目录下，例如 echo.rb 和 multicast.rb。以下是一个简单的启动文件示例：

require 'em-websocket'

EM.run do
  EM::WebSocket.run(:host => "0.0.0.0", :port => 8080) do |ws|
    ws.onopen do |handshake|
      puts "WebSocket connection open"
      ws.send "Hello Client, you connected to #{handshake.path}"
    end

    ws.onclose do
      puts "Connection closed"
    end

    ws.onmessage do |msg|
      puts "Received message: #{msg}"
      ws.send "Pong: #{msg}"
    end
  end
end

启动文件介绍

• require 'em-websocket': 引入 EM-WebSocket 库。
• EM.run do ... end: 启动 EventMachine 事件循环。
• EM::WebSocket.run(...) do |ws| ... end: 启动 WebSocket 服务器，配置主机和端口。
• ws.onopen do |handshake| ... end: 当 WebSocket 连接打开时执行的代码块。
• ws.onclose do ... end: 当 WebSocket 连接关闭时执行的代码块。
• ws.onmessage do |msg| ... end: 当接收到消息时执行的代码块。

3. 项目的配置文件介绍

项目的配置文件主要是 Gemfile 和 em-websocket.gemspec。

Gemfile

Gemfile 用于定义项目的依赖关系，内容如下：

source 'https://rubygems.org'

gem 'em-websocket'

em-websocket.gemspec

em-websocket.gemspec 是项目的 gem 配置文件，内容如下：

Gem::Specification.new do |s|
  s.name        = 'em-websocket'
  s.version     = '0.5.1'
  s.summary     = "EventMachine based WebSocket server"
  s.description = "EventMachine based async Ruby WebSocket server"
  s.authors     = ["Ilya Grigorik", "Martyn Loughran"]
  s.email       = 'ilya@igvita.com'
  s.homepage    = 'https://github.com/igrigorik/em-websocket'
  s.license     = 'MIT'

  s.files = Dir.glob("{lib,spec}/**/*") + %w(LICENSE README.md Rakefile)
  s.test_files = s.files.grep(%r{^(test|spec|features)/

em-websocketEventMachine based WebSocket server项目地址:https://gitcode.com/gh_mirrors/em/em-websocket