mDNS – 微信小程序开发指南

wx.offLocalServiceDiscoveryStop(function listener)

基础库 2.4.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

相关文档: 局域网通信

功能描述

移除 mDNS 服务停止搜索的事件的监听函数

参数

function listener

onLocalServiceDiscoveryStop 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onLocalServiceDiscoveryStop(listener)
wx.offLocalServiceDiscoveryStop(listener) // 需传入与监听时同一个的函数对象

wx.offLocalServiceFound(function listener)

基础库 2.4.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

相关文档: 局域网通信

功能描述

移除 mDNS 服务发现的事件的监听函数

参数

function listener

onLocalServiceFound 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onLocalServiceFound(listener)
wx.offLocalServiceFound(listener) // 需传入与监听时同一个的函数对象

wx.offLocalServiceLost(function listener)

基础库 2.4.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

相关文档: 局域网通信

功能描述

移除 mDNS 服务离开的事件的监听函数

参数

function listener

onLocalServiceLost 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onLocalServiceLost(listener)
wx.offLocalServiceLost(listener) // 需传入与监听时同一个的函数对象

wx.offLocalServiceResolveFail(function listener)

基础库 2.4.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

相关文档: 局域网通信

功能描述

取消监听 mDNS 服务解析失败的事件。

参数

function listener

通过 onLocalServiceResolveFail 传入的监听函数。如果不传此参数，则会移除该事件的所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onLocalServiceResolveFail(listener)
wx.offLocalServiceResolveFail(listener) // 需传入与监听时同一个的函数对象

wx.onLocalServiceDiscoveryStop(function listener)

基础库 2.4.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

相关文档: 局域网通信

功能描述

监听 mDNS 服务停止搜索的事件

参数

function listener

mDNS 服务停止搜索的事件的监听函数

wx.onLocalServiceFound(function listener)

基础库 2.4.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

相关文档: 局域网通信

功能描述

监听 mDNS 服务发现的事件

参数

function listener

mDNS 服务发现的事件的监听函数

参数

Object res

属性	类型	说明
serviceType	string	服务的类型
serviceName	string	服务的名称
ip	string	服务的 ip 地址
port	number	服务的端口

wx.onLocalServiceLost(function listener)

基础库 2.4.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

相关文档: 局域网通信

功能描述

监听 mDNS 服务离开的事件

参数

function listener

mDNS 服务离开的事件的监听函数

参数

Object res

属性	类型	说明
serviceType	string	服务的类型
serviceName	string	服务的名称

wx.onLocalServiceResolveFail(function listener)

基础库 2.4.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

相关文档: 局域网通信

功能描述

监听 mDNS 服务解析失败的事件

参数

function listener

mDNS 服务解析失败的事件的监听函数

参数

Object res

属性	类型	说明
serviceType	string	服务的类型
serviceName	string	服务的名称

wx.startLocalServiceDiscovery(Object object)

基础库 2.4.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

微信鸿蒙 OS 版：支持

相关文档: 局域网通信

功能描述

开始搜索局域网下的 mDNS 服务。搜索的结果会通过 wx.onLocalService* 事件返回。

参数

Object object

属性	类型	必填	说明
serviceType	string	是	要搜索的服务类型
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数

Object res

属性

类型

说明

errMsg

string

错误信息

合法值	说明
invalid param	serviceType 为空
scan task already exist	在当前 startLocalServiceDiscovery 发起的搜索未停止的情况下，再次调用 startLocalServiceDiscovery

示例代码


    wx.startLocalServiceDiscovery({
      // 当前手机所连的局域网下有一个 _http._tcp. 类型的服务
      serviceType: '_http._tcp.',
      success: console.log,
      fail: console.log
    })

注意

由于操作系统相关能力变更，iOS 微信客户端 7.0.18 及以上版本无法使用 mDNS 相关接口，安卓版本不受影响
wx.startLocalServiceDiscovery 是一个消耗性能的行为，开始 30 秒后会自动 stop 并执行 wx.onLocalServiceDiscoveryStop 注册的回调函数。
在调用 wx.startLocalServiceDiscovery 后，在这次搜索行为停止后才能发起下次 wx.startLocalServiceDiscovery。停止本次搜索行为的操作包括调用 wx.stopLocalServiceDiscovery 和 30 秒后系统自动 stop 本次搜索。

wx.stopLocalServiceDiscovery(Object object)

基础库 2.4.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

微信鸿蒙 OS 版：支持

相关文档: 局域网通信

功能描述

停止搜索 mDNS 服务

参数

Object object

属性	类型	必填	说明
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数

Object res

属性

类型

说明

errMsg

string

错误信息

合法值	说明
task not found	在当前没有处在搜索服务中的情况下调用 stopLocalServiceDiscovery