mDNS

最近更新时间:2023-10-20 15:19:18

我的收藏

stopLocalServiceDiscovery

该 API 使用方法为 wx.stopLocalServiceDiscovery(Object object)
功能说明:停止搜索 mDNS 服务。
参数及说明:Object object。
属性
类型
默认值
必填
说明
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
object.fail 回调函数参数:Object res。
属性
类型
说明
errMsg
string
错误信息,其合法值为 task not found:在当前没有处在搜索服务中的情况下调用 stopLocalServiceDiscovery

startLocalServiceDiscovery

该 API 使用方法为 wx.startLocalServiceDiscovery(Object object)
注意:
iOS 需要接入 TMFMiniAppExtMDNS 扩展库才能使用 mDNS 相关接口。
wx.startLocalServiceDiscovery 是一个消耗性能的行为,开始 30 秒后会自动 stop 并执行 wx.onLocalServiceDiscoveryStop 注册的回调函数。
在调用 wx.startLocalServiceDiscovery 后,在这次搜索行为停止后才能发起下次 wx.startLocalServiceDiscovery。停止本次搜索行为的操作包括调用 wx.stopLocalServiceDiscovery 和30秒后系统自动 stop 本次搜索。
功能说明:开始搜索局域网下的 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
})

offLocalServiceResolveFail

该 API 使用方法为 wx.offLocalServiceResolveFail(function listener)
功能说明:移除 mDNS 服务解析失败的事件的监听函数。
参数及说明:function listener,onLocalServiceResolveFail 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }

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

onLocalServiceResolveFail

该 API 使用方法为 wx.onLocalServiceResolveFail(function listener)
功能说明:监听 mDNS 服务解析失败的事件。
参数及说明:Object res 参数,function listener,mDNS 服务解析失败的事件的监听函数。
属性
类型
说明
serviceType
string
服务的类型
serviceName
string
服务的名称

offLocalServiceLost

该 API 使用方法为 wx.offLocalServiceLost(function listener)
功能说明:移除 mDNS 服务离开的事件的监听函数。
参数及说明:function listener,onLocalServiceLost 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }

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

onLocalServiceLost

该 API 使用方法为 wx.onLocalServiceLost(function listener)
功能说明:监听 mDNS 服务离开的事件。
参数及说明:Object res 参数,function listener,mDNS 服务离开的事件的监听函数。
属性
类型
说明
serviceType
string
服务的类型
serviceName
string
服务的名称

offLocalServiceFound

该 API 使用方法为 wx.offLocalServiceFound(function listener)
功能说明:移除 mDNS 服务发现的事件的监听函数。
参数及说明:function listener,onLocalServiceFound 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }

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

onLocalServiceFound

该 API 使用方法为 wx.onLocalServiceFound(function listener)
功能说明:监听 mDNS 服务发现的事件。
参数及说明:Object res 参数,function listener,mDNS 服务发现的事件的监听函数。
属性
类型
说明
serviceType
string
服务的类型
serviceName
string
服务的名称
ip
string
服务的 ip 地址
port
number
服务的端口

offLocalServiceDiscoveryStop

该 API 使用方法为 wx.offLocalServiceDiscoveryStop(function listener)
功能说明:移除 mDNS 服务停止搜索的事件的监听函数。
参数及说明:function listener,onLocalServiceDiscoveryStop 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }

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

onLocalServiceDiscoveryStop

该 API 使用方法为 wx.onLocalServiceDiscoveryStop(function listener)
功能说明:监听 mDNS 服务停止搜索的事件。
参数及说明:function listener,mDNS 服务停止搜索的事件的监听函数。