ConnectWebSocket Processor
描述
充当 WebSocket 客户端端点与远程 WebSocket 服务器交互。 当配置有该处理器的 WebSocket 客户端从远程 WebSocket 服务器接收消息时,FlowFiles 根据接收到的消息类型传输到下游关系。 如果将新的FlowFile传递到处理器,则先前的会话将关闭,并且正在发送的任何数据都将中止。
标签
属性
| 名称 | 默认值 | 可选值 | 描述 |
|---|---|---|---|
| WebSocket Client Controller Service | | 控制器服务 API:WebSocketClientServicecn.org.acal.lynxus-lynxus-websocket-services-api-nar-2.11.8 | 可以连接到 WebSocket 服务器的 WebSocket CLIENT Controller Service。 |
| WebSocket Client Id | | 用于标识 WebSocket 会话的客户端 ID。它在 WebSocket Client 控制器服务内应该是唯一的。否则,在启动时将抛出 WebSocketConfigurationException。 |
关系 (Relationships)
| 名称 | 描述 | 自动终止 |
|---|---|---|
binary message | WebSocket 二进制消息输出 | 否 |
connected | WebSocket 会话已建立 | 否 |
disconnected | WebSocket 会话已断开 | 是 |
failure | FlowFile 保存连接配置属性(例如 URL 或 HTTP 标头),以防连接失败 | 是 |
success | FlowFile 在连接成功时保存连接配置属性(例如 URL 或 HTTP 标头) | 是 |
text message | WebSocket 文本消息输出 | 否 |
写入的 FlowFile 属性
| 名称 | 描述 |
|---|---|
websocket.controller.service.id | WebSocket Controller Service ID。 |
websocket.session.id | 已建立的 WebSocket 会话 ID。 |
websocket.endpoint.id | WebSocket 端点 ID。 |
websocket.local.address | WebSocket 客户端地址。 |
websocket.remote.address | WebSocket 服务器地址。 |
websocket.message.type | 文本或二进制。 |
状态管理
该组件不存储状态。
受限 (Restricted)
该组件不受限。
输入要求
该组件允许有传入连接。
详细说明
ConnectWebSocket
概述
该 Processor 充当 WebSocket 客户端端点,与远程 WebSocket 服务器交互。它能够接收来自 WebSocket 服务器的消息,并根据 接收到的消息类型把它们转移到下游 Relationship。
该 Processor 可以有传入 Relationship,此时 FlowFile Attribute 会被传递到它的 WebSocket Client Service。这可以 用于微调连接配置(例如 url 和 header)。例如, "dynamic.url = currentValue" 这个 FlowFile Attribute 可以在 WebSocket Client Service 中用 ${dynamic.url} 表达式引用。
你可以在传入 FlowFile 中把额外的 Attribute 定义为自定义 WebSocket header。Attribute 键应以 "header." 开头,后接 header 键。例如:"header.Authorization"。Attribute 值就是对应 header 的值。如果新的 FlowFile 被传入该 Processor,之前的会话会被关闭,正在发送的数据会被中止。
- header.Autorization | Basic base64UserNamePassWord
- header.Content-Type | application, audio, example
多个 header 值请提供逗号分隔的列表。