Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-unicloud-zh
提交
47940102
U
unidocs-unicloud-zh
项目概览
DCloud
/
unidocs-unicloud-zh
通知
84
Star
2
Fork
20
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
1
列表
看板
标记
里程碑
合并请求
9
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
unidocs-unicloud-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
1
Issue
1
列表
看板
标记
里程碑
合并请求
9
合并请求
9
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
47940102
编写于
6月 24, 2024
作者:
crlfe
😲
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update: websocket.md
上级
1257d58e
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
27 addition
and
13 deletion
+27
-13
docs/websocket.md
docs/websocket.md
+27
-13
未找到文件。
docs/websocket.md
浏览文件 @
47940102
...
...
@@ -153,12 +153,18 @@ module.exports = {
## 云函数 uniCloud API
### uniCloud.ws.send
用法:
`const ws = uniCloud.webSocketServer()`
返回值:
`WebSocketServer`
### <WebSocketServer.send@uniCloud.ws.send>
>
> 从云函数/云对象中像客户端发送消息
```
javascript
await
uniCloud
.
ws
.
send
(
connectionId
,
sendData
)
const
ws
=
uniCloud
.
webSocketServer
()
await
ws
.
send
(
connectionId
,
sendData
)
```
**参数说明**
...
...
@@ -175,30 +181,33 @@ await uniCloud.ws.send(connectionId, sendData)
exports
.
onWebsocketMessage
=
async
function
(
event
)
{
const
{
connectionId
,
payload
}
=
event
const
ws
=
uniCloud
.
webSocketServer
()
// 发送给单个客户端
await
uniCloud
.
ws
.
send
(
connectionId
,
`receive:
${
payload
}
`
)
await
ws
.
send
(
connectionId
,
`receive:
${
payload
}
`
)
// 发送给多个客户端
await
uniCloud
.
ws
.
send
([
connectionId1
,
connectionId2
,
...],
`receive:
${
payload
}
`
)
await
ws
.
send
([
connectionId1
,
connectionId2
,
...],
`receive:
${
payload
}
`
)
// 发送给客户端对象数据,发送时会自动JSON.stringify
await
uniCloud
.
ws
.
send
(
connectionId
,
{
await
ws
.
send
(
connectionId
,
{
receive
:
payload
})
// 发送给客户端二进制数据
await
uniCloud
.
ws
.
send
(
connectionId
,
Buffer
.
from
(
`receive:
${
payload
}
`
))
await
ws
.
send
(
connectionId
,
Buffer
.
from
(
`receive:
${
payload
}
`
))
}
```
###
uniCloud.ws.close
###
<WebSocketServer.close@uniCloud.ws.close>
>
> 在云函数/云对象中关闭连接
```
javascript
await
uniCloud
.
ws
.
close
(
connectionId
)
const
ws
=
uniCloud
.
webSocketServer
()
await
ws
.
close
(
connectionId
)
```
**参数说明**
...
...
@@ -214,24 +223,27 @@ await uniCloud.ws.close(connectionId)
exports
.
onWebsocketMessage
=
async
function
(
event
)
{
const
{
connectionId
,
payload
}
=
event
const
ws
=
uniCloud
.
webSocketServer
()
// 关闭单个客户端连接
await
uniCloud
.
ws
.
close
(
connectionId
)
await
ws
.
close
(
connectionId
)
// 批量关闭客户端连接
await
uniCloud
.
ws
.
close
([
connectionId1
,
connectionId2
,
...])
await
ws
.
close
([
connectionId1
,
connectionId2
,
...])
}
```
###
uniCloud.ws.signedURL
###
<WebSocketServer.signedURL@uniCloud.ws.signedURL>
>
> 在云函数/云对象中生成WebSocket连接地址
在客户端没有使用 uniCloud SDK 时,可以通过 URL 化在云端生成 WebSocket 连接地址。
```
javascript
await
uniCloud
.
ws
.
signedURL
(
name
,
query
)
const
ws
=
uniCloud
.
webSocketServer
()
await
ws
.
signedURL
(
name
,
query
)
```
**参数说明**
...
...
@@ -248,7 +260,9 @@ WebSocket 连接地址
**示例**
```
javascript
await
uniCloud
.
ws
.
signedURL
(
"
exampleWebSocket
"
,
{
const
ws
=
uniCloud
.
webSocketServer
()
await
ws
.
signedURL
(
"
exampleWebSocket
"
,
{
key
:
"
val
"
})
```
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录