微信小程序开发文档微信小程序API mDNS

2024-02-25 开发教程微信小程序开发文档匿名 2℃

wx.stopLocalServiceDiscovery(Object object)

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

停止搜索 mDNS 服务

参数

Object object

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

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

res.errMsg 的合法值

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

wx.startLocalServiceDiscovery(Object object)

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

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

参数

Object object

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

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

res.errMsg 的合法值

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

示例代码

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

注意

wx.startLocalServiceDiscovery 是一个消耗性能的行为，开始 30 秒后会自动 stop 并执行 wx.onLocalServiceDiscoveryStop 注册的回调函数。
在调用 wx.startLocalServiceDiscovery 后，在这次搜索行为停止后才能发起下次 wx.startLocalServiceDiscovery。停止本次搜索行为的操作包括调用 wx.stopLocalServiceDiscovery 和 30 秒后系统自动 stop 本次搜索。

wx.onLocalServiceResolveFail(function callback)

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

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

参数

function callback

mDNS 服务解析失败的事件的回调函数

参数

Object res

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

wx.onLocalServiceLost(function callback)

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

监听 mDNS 服务离开的事件

参数

function callback

mDNS 服务离开的事件的回调函数

参数

Object res

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

wx.onLocalServiceFound(function callback)

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

监听 mDNS 服务发现的事件

参数

function callback

mDNS 服务发现的事件的回调函数

参数

Object res

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

wx.onLocalServiceDiscoveryStop(function callback)

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

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

参数

function callback

mDNS 服务停止搜索的事件的回调函数

wx.offLocalServiceResolveFail(function callback)

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

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

参数

function callback

mDNS 服务解析失败的事件的回调函数

wx.offLocalServiceLost(function callback)

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

取消监听 mDNS 服务离开的事件

参数

function callback

mDNS 服务离开的事件的回调函数

wx.offLocalServiceFound(function callback)

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

取消监听 mDNS 服务发现的事件

参数

function callback

mDNS 服务发现的事件的回调函数

wx.offLocalServiceDiscoveryStop(function callback)

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

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

参数

function callback

mDNS 服务停止搜索的事件的回调函数

上一节：微信小程序API Websocket

下一节：微信小程序API UDP通信

"微信小程序开发文档"的目录

微信小程序开发文档 微信小程序API mDNS

wx.stopLocalServiceDiscovery(Object object)

参数

Object object

object.fail 回调函数

参数

Object res

wx.startLocalServiceDiscovery(Object object)

参数

Object object

object.fail 回调函数

参数

Object res

示例代码

注意

wx.onLocalServiceResolveFail(function callback)

参数

function callback

参数

Object res

wx.onLocalServiceLost(function callback)

参数

function callback

参数

Object res

wx.onLocalServiceFound(function callback)

参数

function callback

参数

Object res

wx.onLocalServiceDiscoveryStop(function callback)

参数

function callback

wx.offLocalServiceResolveFail(function callback)

参数

function callback

wx.offLocalServiceLost(function callback)

参数

function callback

wx.offLocalServiceFound(function callback)

参数

function callback

wx.offLocalServiceDiscoveryStop(function callback)

参数

function callback

微信小程序开发文档微信小程序API mDNS