WebSockets

更新时间:2024-08-14 19:50:33

WebSocket API 允许您与 CDNetworks Edge Cloud Apps 函数进行实时双向通。

构造函数

new WebSocketPair()

返回值: WebSocketPair 对象。

描述: WebSocketPair 对象包含两个 WebSocket 对象,分别表示客户端和服务器端。 您可以使用数组解构来方便地获取这两个对象:

let [client, server] = Object.values(new WebSocketPair());

方法

accept()

描述: 接受 WebSocket 连接请求,并允许 Edge Cloud Apps 函数开始处理 WebSocket 消息。

addEventListener()

addEventListener(event: WebSocketEvent, callbackFunction: Function)

参数:

参数名称 类型 描述
event WebSocketEvent 要监听的 WebSocket 事件。
callbackFunction Function 当指定的事件发生时要调用的函数。

描述: 为 WebSocket 对象添加事件监听器。 当指定的事件发生时,将执行回调函数。

close()

close(code?: number, reason?: string)

参数:

参数名称 类型 描述
code number 可选。 一个整数,表示关闭连接的原因代码。 遵循 WebSocket 协议规范中定义的状态代码。
reason string 可选。一个可读字符串,解释连接关闭的原因。

描述: 关闭 WebSocket 连接。

send()

send(message: string \| ArrayBuffer \| ArrayBufferView)

参数:

  • message: 要发送的消息。 可以是字符串、ArrayBufferArrayBufferView

描述: 向连接的另一端发送消息。

事件

close

描述: 当 WebSocket 连接关闭时触发该事件。

error

描述: 当 WebSocket 连接发生错误时触发该事件。

message

描述: 当 WebSocket 连接收到消息时触发该事件。 事件对象包含接收到的数据。

类型

Message

属性名 类型 描述
data any 接收到的消息数据。
type string 消息类型,默认为 “message”。

相关资源

本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!