Celluloid::IO 使用与技术文档

1. 安装指南

首先，您需要在您的应用程序的 Gemfile 中添加以下代码：

gem 'celluloid-io'

然后执行以下命令来安装 gem：

$ bundle

或者，您也可以自行安装：

$ gem install celluloid-io

在您的 Ruby 程序中，通过以下方式来引用 Celluloid::IO：

require 'celluloid/io'

2. 项目的使用说明

Celluloid::IO 是一个事件驱动的 IO 系统，旨在构建快速、可扩展的网络应用，并且能够与 Celluloid actor library 直接集成，轻松结合线程和事件的概念。Celluloid::IO 非常适合处理大量主要是空闲连接的服务器，例如 Websocket 服务器或聊天/消息系统。

Celluloid::IO 提供了一类不同的 actor：比标准的 Celluloid actors 略微慢和重，但包含一个高性能的反应器，就像 EventMachine 或 Cool.io 一样。这意味着 Celluloid::IO actors 拥有 Celluloid actors 和事件驱动 IO 循环的双重力量。与其他某些限制每个进程只能有一个事件循环的事件驱动 IO 系统不同，Celluloid::IO 允许您根据系统资源的允许，创建任意数量的 actors。

Celluloid::IO 通过使用 Ruby 自身 IO 类的鸭类型来暴露一个同步 API，如 TCPServer 和 TCPSocket。这些类与其 Ruby 核心类完全相同，但在 Celluloid::IO actors 的范围内提供“事件驱动”的性能。由于它们是标准类的即插即用替代品，因此无需重写每个库以利用 Celluloid::IO 的事件循环，并且可以在单个连接的生命周期内自由地在事件驱动和阻塞 IO 之间切换。

Celluloid::IO 使用 nio4r gem 来监控 IO 对象，它提供了跨平台和跨 Ruby 实现访问高性能系统调用（如 epoll 和 kqueue）的能力。

3. 项目API使用文档

关于 Celluloid::IO 的更多详细文档和使用说明，请参阅 Celluloid::IO Wiki。

另外，也可以访问 YARD 文档。

4. 项目安装方式

Celluloid::IO 支持在所有 Ruby (MRI) 版本之间运行，版本范围是 1.9.3 至 2.3.1，JRuby 的 1.6.*、1.7.* 和 9.* 系列，以及 Rubinius 的 2.* 和 3.* 系列。

推荐使用 Jruby 或 Rubinius 作为平台，因为它们在执行 Ruby 代码时支持真正的线程级并行，而 MRI/YARV 由于全局解释器锁（GIL）的限制，每次只能执行一个线程。

Celluloid::IO 需要 Ruby 1.9 模式在所有解释器上至少运行。

如果您希望为 Celluloid::IO 做贡献，可以按照以下步骤操作：

• 在 github 上分叉此仓库
• 进行修改并发送 pull 请求
• 如果我喜欢您的修改，我会合并它们
• 如果我已经接受了一个补丁，您可以自由地请求一个提交位！

本项目遵循 MIT 许可，版权所有（c）2011-2016 Tony Arcieri。包含来自 RubySpec 项目和 'OpenSSL for Ruby 2' 项目的原始代码，也遵循 MIT 许可和 Ruby 许可。