BERTRPC 技术文档

1. 安装指南

在开始使用BERTRPC之前，需要先进行安装。安装非常简单，只需使用以下命令安装Ruby的BERTRPC客户端库：

$ gem install bertrpc

确保你的系统中已经安装了Ruby和gem包管理器。

2. 项目的使用说明

BERTRPC是一个Ruby客户端库，它使得与BERT-RPC服务器的交互变得极其简单。BERTRPC目前支持BERT-RPC规范中的以下特性：

• call 请求：用于从服务器请求响应的操作。
• cast 请求：用于向服务器发送消息但不期待响应的操作。

BERTRPC已经被GitHub用于生产环境，并且每天执行数百万个RPC请求，其稳定性和性能都非常好。

创建服务

使用以下代码创建一个新的BERTRPC服务：

require 'bertrpc'
svc = BERTRPC::Service.new('localhost', 9999)

您还可以指定一个读取超时：

# 10秒的socket读取超时，如果超时会抛出 BERTRPC::ReadTimeoutError
svc = BERTRPC::Service.new('localhost', 9999, 10)

调用操作

以下是一个调用操作的示例，该操作将调用名为calc的服务中的add方法，并传递两个参数1和2：

svc.call.calc.add(1, 2)
# 返回 3

底层BERT-RPC事务如下：

-> {call, calc, add, [1, 2]}
<- {reply, 3}

广播操作

以下是一个广播操作的示例，该操作将向名为stats的服务发送incr消息，不期待返回值：

svc.cast.stats.incr
# 返回 nil

底层BERT-RPC事务如下：

-> {cast, stats, incr, []}
<- {noreply}

3. 项目API使用文档

本项目提供的API接口非常简单，主要包括以下类和方法：

• BERTRPC::Service.new(host, port, [timeout]): 创建一个新的BERTRPC服务实例。
• #call(service_name, method_name, *args): 发送一个BERT-RPC call 请求到服务器。
• #cast(service_name, method_name, *args): 发送一个BERT-RPC cast 请求到服务器。

4. 项目安装方式

本项目的安装方式已在安装指南部分详细介绍，概括来说，就是通过gem命令安装BERTRPC Ruby库。

确保您的系统中已经安装了Ruby环境以及gem工具。使用以下命令安装：

$ gem install bertrpc

以上就是关于BERTRPC项目的详细技术文档。希望对您使用本项目有所帮助。