跳到主要内容

Websocket

作为客户端连接第三方 WebSocket 服务,或向连到 本机 Websocket 服务 的客户端发数据。

当前模块定义

sys:websocket网络服务Action
标准模块
输入 10 · 输出 2 · 枚举 1

输入参数

  • 操作类型operationEnum必填
    填写 固定输入默认 CreateClient
    7 个选项客户端:连接到Websocket服务、客户端:向Websocket服务发送消息、客户端:获取连接状态
    客户端:连接到Websocket服务默认CreateClient
    客户端:向Websocket服务发送消息SendMsgToServer
    客户端:获取连接状态GetClientState
    客户端:关闭连接CloseClient
    服务器:向连接的客户端发送文本SendTextToClient
    服务器:向连接的客户端发送文件(二进制方式SendFileToClient
    服务器:向连接的客户端发送文件(Base64方式SendFileToClientBase64
  • 服务器地址serverText可选
    填写 输入或变量条件 仅:CreateClient
  • 连接IDclientIdText可选

    用于区分不同的客户端连接。连接相同id的客户端时,前一个连接会被自动关闭。

    填写 输入或变量条件 仅:CreateClient, SendMsgToServer, GetClientState, CloseClient
  • 消息处理子程序spNameText可选

    使用子程序处理从websocket服务接收到的消息。详情请参考文档。

    填写 输入或变量条件 仅:CreateClient
  • 账号密码accountText可选

    支持Basic和Digest认证方式。多行填写。第一行写账号,第二行写密码。

    填写 输入或变量条件 仅:CreateClient
  • OriginoriginText可选

    仅需要时填写

    填写 输入或变量条件 仅:CreateClient
  • CookiecookieText可选

    请求的cookie内容

    填写 输入或变量条件 仅:CreateClient
  • 消息内容contentText可选

    文本内容。发送文件时为文件的完整路径。

    填写 输入或变量条件 仅:CreateClient, SendTextToClient, SendFileToClient, SendFileToClientBase64, SendMsgToServer
  • 服务断开时通知动作(调用动作并传入参数:websocket__closed)callbackOnCloseBoolean可选

    是否等待服务器响应

    填写 固定输入条件 仅:CreateClient默认 true
  • 失败后停止stopIfFailBoolean可选

    失败后是否停止动作

    填写 固定输入默认 true

输出参数

  • 是否成功isSuccessBoolean

    操作是否成功

  • 是否连接isConnectedBoolean

    指定客户端是否连接到远程服务器

    条件 仅:GetClientState

概述

Websocket

Websocket相关操作
操作类型
服务器地址
 
连接ID
 
用于区分不同的客户端连接。连接相同id的客户端时,前一个连接会被自动关闭。
消息处理子程序
 
使用子程序处理从websocket服务接收到的消息。详情请参考文档。
账号密码
 
支持Basic和Digest认证方式。多行填写。第一行写账号,第二行写密码。
Origin
 
仅需要时填写
Cookie
 
请求的cookie内容
消息内容
 
文本内容。发送文件时为文件的完整路径。
是否成功
-- 选择变量 --
操作是否成功

参数说明

操作类型

  • 客户端:连接到 Websocket 服务
  • 客户端:向 Websocket 服务发送消息
  • 客户端:获取连接状态
  • 客户端:关闭连接
  • 服务器:向连接的客户端发送文本
  • 服务器:向连接的客户端发送文件(二进制)
  • 服务器:向连接的客户端发送文件(Base64)

服务器地址:仅创建连接。第三方 ws:// / wss:// 地址。

连接ID:标识一条连接。后续发送、查状态、关闭都靠它。再次用同一 ID 创建时,会先关掉旧连接。

消息处理子程序:仅创建连接。收到文本消息时调用。详见下文。

消息内容:创建连接后立刻发送的文本;向服务端或客户端发送时填正文;发文件时填完整路径。

账号密码:仅创建连接。支持 Basic / Digest。第一行用户名,第二行密码。

Cookie:仅创建连接。每行 name:value

Origin:仅创建连接。需要时再填 HTTP Origin。

服务断开时通知动作(调用动作并传入参数:websocket__closed):仅创建连接。默认开启。旧稿未写。

失败后停止:失败是否中止动作。默认开启。

输出

  • 是否成功
  • 是否连接:仅获取连接状态。指定 ID 是否连着远程服务器。

创建 Websocket 连接

Quicker 当客户端连第三方服务时用。大致流程:

  1. 先写好接收消息的子程序。
  2. 连接并指定 连接ID 和子程序。连接会保持,即使动作已经结束。
  3. 之后用同一 连接ID 发消息。
  4. 收到消息后调用子程序;若子程序的 Response 输出非空,会回给服务器。

设计接收消息处理子程序

目前只支持文本消息。Quicker 把详情放进子程序的 Data 输入。处理完后赋给 Response 输出;非空就会发回服务器。

子程序会被直接调用,不必加进主程序步骤,主程序步骤也不会因此执行。

连接到 Websocket 服务

Websocket

Websocket相关操作
操作类型
服务器地址
wss://socketsbay.com/wss/v2/2/demo/
连接ID
test
用于区分不同的客户端连接。连接相同id的客户端时,前一个连接会被自动关闭。
消息处理子程序
消息处理
使用子程序处理从websocket服务接收到的消息。详情请参考文档。
账号密码
 
支持Basic和Digest认证方式。多行填写。第一行写账号,第二行写密码。
Origin
 
仅需要时填写
Cookie
 
请求的cookie内容
消息内容
 
文本内容。发送文件时为文件的完整路径。
是否成功
isSuccess
操作是否成功

向 Websocket 服务发送消息

Websocket

Websocket相关操作
操作类型
连接ID
test
用于区分不同的客户端连接。连接相同id的客户端时,前一个连接会被自动关闭。
消息内容
 
文本内容。发送文件时为文件的完整路径。
是否成功
isSuccess
操作是否成功

获取连接状态 / 关闭连接

获取指定 ID 是否已连接,或关掉它。

https://tools.getquicker.cn/ws 提供回显服务,可用来试。

向本机服务的客户端发送

向已连接到 本机 Websocket 服务 的客户端发内容。可选文本、二进制文件或 Base64 文件。消息格式见该文档。

Websocket

Websocket相关操作
操作类型
消息内容
{"type":"msg", "Data":"Hello From Quicker"}
文本内容。发送文件时为文件的完整路径。
是否成功
isSuccess
操作是否成功

限制与排障

接收处理目前只支持文本。连接断开后,若打开了断开通知,动作会收到参数 websocket__closed。同一 连接ID 再次创建会顶掉旧连接。

相关链接

更新于