BrB 分布式 Ruby 项目技术文档

1. 安装指南

1.1 环境要求

• Ruby 版本：2.0 及以上
• 依赖库：EventMachine

1.2 安装步骤

1. 打开终端或命令行工具。
2. 使用 gem 命令安装 BrB：

   gem install brb
   

3. 安装完成后，可以通过以下命令确认安装是否成功：

   ruby -e "require 'brb'; puts BrB::VERSION"
   

2. 项目的使用说明

2.1 基本概念

BrB 是一个简单、透明且高效的分布式 Ruby 接口，基于 EventMachine 构建。它允许 Ruby 进程之间进行快速的消息传递，并支持返回值的处理。

2.2 主要功能

• 无限对象暴露：一个进程可以暴露多个对象。
• 同时作为客户端和服务器：进程可以同时暴露对象并连接到其他暴露的对象。
• 默认非阻塞消息传递：默认情况下，消息传递是非阻塞的。
• 返回值处理：通过使用简单的块来处理返回值。
• 阻塞等待返回值：如果需要阻塞等待返回值，可以在方法名后添加 _block。
• 异常传输：在阻塞调用中传输异常。
• 线程安全：如果正确使用 EventMachine，BrB 是线程安全的。

2.3 使用示例

以下是一个简单的使用示例，展示如何暴露对象并进行方法调用：

require 'brb'

# 服务器端
server = BrB::Server.new('localhost', 4000)
server.expose(:my_object) do
  # 暴露的对象
  { name: 'BrB', version: '1.0' }
end

# 客户端
client = BrB::Client.new('localhost', 4000)
result = client.my_object.name
puts result  # 输出: BrB

3. 项目 API 使用文档

3.1 BrB::Server

• new(host, port)：创建一个服务器实例，绑定到指定的 host 和 port。
• expose(object_name, &block)：暴露一个对象，object_name 是对象的名称，block 是对象的定义。

3.2 BrB::Client

• new(host, port)：创建一个客户端实例，连接到指定的 host 和 port。
• method_missing(method_name, *args)：动态调用暴露对象的方法。

3.3 方法调用

• 非阻塞调用：直接调用方法，不等待返回值。
• 阻塞调用：在方法名后添加 _block，例如 my_method_block。

4. 项目安装方式

4.1 通过 RubyGems 安装

gem install brb

4.2 手动安装

1. 从 GitHub 下载项目源码。
2. 解压后进入项目目录。
3. 运行以下命令进行安装：

   ruby setup.rb
   

通过以上步骤，您可以顺利安装并使用 BrB 进行分布式 Ruby 开发。