EasyTier/easytier-contrib/easytier-ohrs/package

easytier-ohrs

Install

use ohpm to install package.

ohpm install easytier-ohrs

API

collectNetworkInfos

collectNetworkInfos(): Array<KeyValuePair>

获取正在运行的网络实例的信息。

---

collectRunningNetwork

collectRunningNetwork(): Array<string>

获取当前正在运行的网络实例名称列表。

---

convertTomlToNetworkConfig

convertTomlToNetworkConfig(cfgStr: string): string

将 TOML 配置转换为 NetworkConfig。

• cfgStr：TOML 配置内容

---

defaultNetworkConfig

defaultNetworkConfig(): string

获取默认的网络配置（JSON 字符串），用于转换为object进行赋值。

---

easytierVersion

easytierVersion(): string

获取 EasyTier 当前版本号。

---

hilogGlobalOptions

hilogGlobalOptions(domain: number, tag: string): void

设置全局日志选项。

• domain：日志域 ID
• tag：日志标签

---

initPanicHook

initPanicHook(): void

初始化 panic 钩子，用于将Rust侧的panic输出到hilog中，请先通过 hilogGlobalOptions 设置hilog的参数。

---

initTracingSubscriber

initTracingSubscriber(): void

初始化 tracing 日志订阅器，用于将Rust侧日志同步输出到hilog中，请先通过 hilogGlobalOptions 设置hilog的参数。

---

isRunningNetwork

isRunningNetwork(instId: string): boolean

判断指定网络实例是否正在运行。

• instId：网络实例 ID

---

parseNetworkConfig

parseNetworkConfig(cfgJson: string): boolean

校验网络配置（JSON 格式）是否合法。

• cfgJson：网络配置内容

---

runNetworkInstance

runNetworkInstance(cfgJson: string): boolean

启动网络实例。

• cfgJson：网络配置（JSON）

---

setTunFd

setTunFd(instId: string, fd: number): boolean

为指定网络实例设置 TUN 设备文件描述符。

• instId：网络实例 ID
• fd：TUN 设备文件描述符

---

stopNetworkInstance

stopNetworkInstance(instNames: Array<string>): void

停止指定的网络实例。

• instNames：网络实例名称列表

Usage

// todo