分类： 网络

UDPSocket.write(Object object)

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

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

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

用法与 send 方法相同，如果没有预先调用 connect 则与 send 无差异（注意即使调用了 connect 也需要在本接口填入地址和端口参数）

参数

Object object

属性 类型 默认值 必填 说明
address string 是 要发消息的地址。在基础库 <= 2.9.3 版本必须是和本机同网段的 IP 地址，或安全域名列表内的域名地址；之后版本可以是任意 IP 和域名
port number 是 要发送消息的端口号
message string/ArrayBuffer 是 要发送的数据
offset number 0 否 发送数据的偏移量，仅当 message 为 ArrayBuffer 类型时有效
length number message.byteLength 否 发送数据的长度，仅当 message 为 ArrayBuffer 类型时有效
setBroadcast boolean false 否 向指定地址发消息时，是否要开启广播，基础库 2.24.0 开始支持

示例代码


  const udp = wx.createUDPSocket()
  udp.bind()
  udp.connect({
    address: '192.168.193.2',
    port: 8848,
  })
  udp.write({
    address: '192.168.193.2',
    port: 8848,
    message: 'hello, how are you'
  })

UDPSocket.setTTL(number ttl)

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

微信小程序插件：支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

设置 IP_TTL 套接字选项，用于设置一个 IP 数据包传输时允许的最大跳步数

参数

number ttl

ttl 参数可以是 0 到 255 之间

示例代码


  const udp = wx.createUDPSocket()
  udp.onListening(function () {
    udp.setTTL(64)
  })
  udp.bind()

UDPSocket.send(Object object)

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

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

向指定的 IP 地址和端口号发送消息。从基础库 2.9.0 版本开始，支持广播功能（将地址设置为 255.255.255.255 即可）。

参数

Object object

属性 类型 默认值 必填 说明
address string 是 要发送消息的地址。在基础库版本小于或等于 2.9.3 时，必须是和当前设备处于同一网段的 IP 地址，或者是安全域名列表中的域名地址；之后的版本则可以是任意 IP 地址和域名
port number 是 要发送消息的端口号
message string/ArrayBuffer 是 要发送的数据内容
offset number 0 否 发送数据的起始偏移量，仅在 message 为 ArrayBuffer 类型时生效
length number message.byteLength 否 发送数据的长度，仅在 message 为 ArrayBuffer 类型时生效
setBroadcast boolean false 否 向指定地址发送消息时，是否开启广播模式，从基础库 2.24.0 版本开始支持

示例代码


  const udp = wx.createUDPSocket()
  udp.bind()
  udp.send({
    address: '192.168.193.2',
    port: 8848,
    message: 'hello, how are you'
  })

UDPSocket.onMessage(function listener)

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

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

监听收到消息的事件

参数

function listener

收到消息的事件的监听函数

参数

Object res
属性 类型 说明
message ArrayBuffer 收到的消息。消息长度需要小于4096。
remoteInfo Object 发送端地址信息
结构属性 类型 说明
address string 发送消息的 socket 的地址
family string 使用的协议族，为 IPv4 或者 IPv6
port number 端口号
size number message 的大小，单位：字节
localInfo Object 接收端地址信息，2.18.0 起支持
结构属性 类型 说明
address string 接收消息的 socket 的地址
family string 使用的协议族，为 IPv4 或者 IPv6
port number 端口号

UDPSocket.onError(function listener)

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

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

监听错误事件

参数

function listener

错误事件的监听函数

参数

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

UDPSocket.offMessage(function listener)

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

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

移除收到消息的事件的监听函数

参数

function listener

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

示例代码

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

UDPSocket.onMessage(listener)
UDPSocket.offMessage(listener) // 需传入与监听时同一个的函数对象

UDPSocket.offListening(function listener)

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

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

取消监听开始接收数据包消息的事件。也就是移除之前设置的监听函数，之后不再触发该回调。

参数

function listener

通过 onListening 传入的监听函数。如果不传这个参数，就会移除所有监听函数。

示例代码

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

UDPSocket.onListening(listener)
UDPSocket.offListening(listener) // 需传入与监听时同一个的函数对象

UDPSocket.offError(function listener)

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

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

移除错误事件的监听函数

参数

function listener

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

示例代码

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

UDPSocket.onError(listener)
UDPSocket.offError(listener) // 需传入与监听时同一个的函数对象