mdns 项目技术文档

1. 安装指南

1.1 系统要求

在安装 mdns 之前，请确保您的系统满足以下要求：

• Linux 系统：如果您使用的是 Linux 系统，并且依赖于 avahi 守护进程，您需要安装 avahi-compat-libdnssd-dev（Debian 系列系统）或 avahi-compat-libdns_sd-devel（Fedora 系列系统）。
• Windows 系统：在 Windows 上，您需要安装 Apple 的 "Bonjour SDK for Windows"。安装后，请确保 BONJOUR_SDK_HOME 环境变量已设置，并且您需要一个编译器（如 Microsoft Visual Studio Express）。
• 其他平台：建议使用 Apple 的 mDNSResponder。

1.2 安装步骤

您可以通过 npm 安装 mdns：

npm install mdns

如果您想使用最新的源代码，可以使用以下命令：

git clone http://github.com/agnat/node_mdns
cd node_mdns
npm link && npm test

如果您想在发布包时使用开发版本的 mdns，可以在 package.json 中设置版本字段为 tarball URL：

{
  "name": "discomvobulator",
  "version": "0.0.1",
  "description": "covers all your discomvobulation needs",
  "dependencies": {
    "mdns": "https://github.com/agnat/node_mdns/tarball/master"
  }
}

2. 项目的使用说明

2.1 基本用法

mdns 提供了基于对象的接口，用于在本地网络上宣布和浏览服务。以下是一个简单的示例：

// 导入模块
const mdns = require('mdns');

// 宣布一个在端口 4321 上的 HTTP 服务
const ad = mdns.createAdvertisement(mdns.tcp('http'), 4321);
ad.start();

// 监听所有 HTTP 服务
const browser = mdns.createBrowser(mdns.tcp('http'));
browser.on('serviceUp', service => {
  console.log("服务上线: ", service);
});
browser.on('serviceDown', service => {
  console.log("服务下线: ", service);
});
browser.start();

// 发现所有可用的服务类型
const all_the_types = mdns.browseThemAll(); // all_the_types 是另一个浏览器...

2.2 事件监听

mdns 提供了 serviceUp 和 serviceDown 事件，分别用于监听服务的上线和下线。您可以通过这些事件来处理服务的发现和消失。

3. 项目API使用文档

3.1 createAdvertisement(serviceType, port)

• 功能：创建并启动一个服务广告。
• 参数：
  • serviceType：服务类型，例如 mdns.tcp('http')。
  • port：服务监听的端口。
• 返回值：返回一个广告对象，可以通过 ad.start() 启动广告。

3.2 createBrowser(serviceType)

• 功能：创建一个服务浏览器。
• 参数：
  • serviceType：服务类型，例如 mdns.tcp('http')。
• 返回值：返回一个浏览器对象，可以通过 browser.start() 启动浏览器。

3.3 browseThemAll()

• 功能：发现所有可用的服务类型。
• 返回值：返回一个浏览器对象，用于发现所有服务类型。

4. 项目安装方式

4.1 通过 npm 安装

最简单的安装方式是通过 npm 安装：

npm install mdns

4.2 从源代码安装

如果您想使用最新的源代码，可以按照以下步骤操作：

git clone http://github.com/agnat/node_mdns
cd node_mdns
npm link && npm test

4.3 使用开发版本

如果您想在发布包时使用开发版本的 mdns，可以在 package.json 中设置版本字段为 tarball URL：

{
  "name": "discomvobulator",
  "version": "0.0.1",
  "description": "covers all your discomvobulation needs",
  "dependencies": {
    "mdns": "https://github.com/agnat/node_mdns/tarball/master"
  }
}

通过以上步骤，您可以顺利安装并使用 mdns 项目。