ArcusNode 技术文档

1. 安装指南

ArcusNode 运行在 Node.js v0.5.5 或更高版本上。要从 GitHub 安装 ArcusNode 并将其作为服务使用，请按照以下步骤操作：

$> git clone https://github.com/OpenRTMFP/ArcusNode.git
$> cd ArcusNode
$> node-waf configure build
$> node service.js

运行上述命令后，您应该会看到如下输出：

Starting up ArcusNode RTMFP Service.
Copyright (C) 2011 OpenRTMFP
This program comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain conditions.
(For usage help type "node service.js -h")
ArcusNode RTMFP Service running at 0.0.0.0:1935

1935 是默认的 RTMFP 通信端口，此时您应该能够连接到服务器，创建群组并连接对等节点。

如果在 Cygwin 上构建 Node.js 时遇到问题，请查阅 Building-node.js-on-Cygwin-(Windows)。

2. 项目的使用说明

在您的 Node.js 项目中使用 ArcusNode 非常简单。以下是一个基本示例：

var ArcusNode = require('./lib/arcus_node.js');
var arcusService = new ArcusNode();
arcusService.run();

ArcusNode 使用事件和注册的命令回调的组合。事件的行为类似于 Node 核心事件。命令由连接的客户端通过其 NetConnection#call 调用，并在 ArcusNode 上注册。

3. 项目API使用文档

以下是一些 ArcusNode API 的使用示例：

事件监听

ArcusNode 会触发以下事件：

• start
• stop
• handshake
• connect
• disconnect
• command

这是一个连接事件监听的示例：

var ArcusNode = require('./lib/arcus_node.js');
var arcusService = new ArcusNode();

arcusService.on('connect', function(nc, obj){
  console.log('Received a connection request for Connection ' + nc.id + ' with the properties', obj);
});

arcusService.run();

命令

以下是一个客户端命令的示例：

var responder = new Responder(function(response) {
  console.log(response.what); //-> 'ArcusNode rocks!'
});
connection.call('sayWhat', responder, { name: 'ArcusNode' });

以下是一个服务器端命令的示例：

arcusService.onCommand('sayWhat', function(nc, obj){
  return { what: obj.name + ' rocks!' };
});

ArcusNode 设置

ArcusNode 构造函数接受一个包含以下属性的设置对象：

.port
  类型：整数
  默认值：1935
  ArcusNode 将监听 UDP 连接的端口。

.address
  类型：字符串
  默认值：''
  如果需要，ArcusNode 可以在特定的接口上运行。

.logLevel
  类型：字符串
  默认值：'warn'
  可选值有 ['fatal', 'error', 'warn', 'info', 'debug']。

.logFile
  类型：字符串，路径
  默认值：''
  如果指定了日志文件的路径，所有日志将被写入该文件。

.manageInterval
  类型：整数，秒
  默认值：60
  管理周期执行清理的时间间隔。

.connectionTimeout
  类型：整数，毫秒
  默认值：120000
  如果 NetConnection 在该时间段内未使用，连接将被丢弃。

.groupTimeout
  类型：整数，毫秒
  默认值：360000
  如果群组在该时间段内没有交互，群组将被丢弃。

.serverKeepalive
  类型：整数，毫秒
  默认值：60000
  在发送对客户端的保活命令之前的时间。

.clientKeepalive
  类型：整数，毫秒
  默认值：60000
  告诉客户端应发送保活消息的时间间隔。

.maxKeepalives
  类型：整数
  默认值：3
  在断开连接之前最多发送多少次保活。

4. 项目安装方式

请参考上述“安装指南”部分提供的步骤进行安装。