# Interface: UDPSocket
• UDPSocket()
一个 UDP Socket 实例，默认使用 IPv4 协议。
# Methods
# bind
▸ bind(port?: number): number
当前兼容平台<wx,qq> 绑定一个系统随机分配的可用端口，或绑定一个指定的端口号
# 参数:
| 属性 | 类型 | 描述 |
|---|---|---|
port? | number | 指定要绑定的端口号，不传则返回系统随机分配的可用端口 |
# 返回值:
number
绑定成功的端口号
# close
▸ close(): void
当前兼容平台<wx,qq> 关闭 UDP Socket 实例，相当于销毁。 在关闭之后，UDP Socket 实例不能再发送消息，每次调用 UDPSocket.send 将会触发错误事件，并且 message 事件回调函数也不会再也执行。 在 UDPSocket 实例被创建后将被 Native 强引用，保证其不被 GC。 在 UDPSocket.close 后将解除对其的强引用，让 UDPSocket 实例遵从 GC。
# 返回值:
void
# offClose
▸ offClose(callback?: Function): void
当前兼容平台<wx,qq> 取消监听关闭事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | Function |
# 返回值:
void
# offError
▸ offError(callback?: OnUDPSocketErrorCallback): void
当前兼容平台<wx,qq> 取消监听错误事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | OnUDPSocketErrorCallback |
# 返回值:
void
# offListening
▸ offListening(callback?: Function): void
当前兼容平台<wx,qq> 取消监听开始监听数据包消息的事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | Function |
# 返回值:
void
# offMessage
▸ offMessage(callback?: OnMessageCallback): void
当前兼容平台<wx,qq> 取消监听收到消息的事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | OnMessageCallback |
# 返回值:
void
# onClose
▸ onClose(callback: Function): void
当前兼容平台<wx,qq> 监听关闭事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | Function |
# 返回值:
void
# onError
▸ onError(callback: OnUDPSocketErrorCallback): void
当前兼容平台<wx,qq> 监听错误事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | OnUDPSocketErrorCallback |
# 返回值:
void
# onListening
▸ onListening(callback: Function): void
当前兼容平台<wx,qq> 监听开始监听数据包消息的事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | Function |
# 返回值:
void
# onMessage
▸ onMessage(callback: OnMessageCallback): void
当前兼容平台<wx,qq> 监听收到消息的事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | OnMessageCallback |
# 返回值:
void
# send
▸ send(obj: object): void
当前兼容平台<wx,qq> 向指定的 IP 和 port 发送消息
# 参数:
▪ obj: object
| 属性 | 类型 | 描述 |
|---|---|---|
address | string | 要发消息的地址。 在基础库 2.9.3 及之前版本可以是一个和本机同网段的 IP 地址，也可以是在安全域名列表内的域名地址； 在基础库 2.9.4 及之后版本，可以是任意 IP 和域名 |
message | string | 要发送的数据 |
port | number | 要发送消息的端口号 |
# 返回值:
void
▸ send(obj: object): void
当前兼容平台<wx,qq> 向指定的 IP 和 port 发送消息
# 参数:
▪ obj: object
| 属性 | 类型 | 描述 |
|---|---|---|
address | string | 要发消息的地址。 在基础库 2.9.3 及之前版本可以是一个和本机同网段的 IP 地址，也可以是在安全域名列表内的域名地址； 在基础库 2.9.4 及之后版本，可以是任意 IP 和域名 |
length? | number | 发送数据的长度，仅当 message 为 ArrayBuffer 类型时有效 |
message | ArrayBuffer | 要发送的数据 |
offset? | number | 发送数据的偏移量，仅当 message 为 ArrayBuffer 类型时有效 |
port | number | 要发送消息的端口号 |
# 返回值:
void