通信

TCP客户端

作为 TCP 客户端连接远端并收发数据，支持长度前缀、分隔符或原始流三种组帧方式，可绑定通信配置复用常驻连接
TcpClientTool · v1.0 · by system

输入参数 9

名称	keyId	类型	默认值	可连接	说明
通信配置ID	`commId`	enum	（空）	否	填入 HardwareConfig 中的通信配置编号后走常驻路径复用共享连接，留空则由本工具自行建立与关闭一条 TCP 连接，连接参数改由目标IP和端口手工指定
目标IP	`host`	string	127.0.0.1	否	要连接的服务端 IP 地址，通信配置编号留空时必填；connect 操作读取该值，地址缺失会返回 -1 并在运行信息提示 host/port 缺失或非法
端口	`port`	int	502	否	服务端监听端口，合法范围 1~65535，默认 502；connect 时取 0、负数或大于 65535 会返回 -1 并在运行信息提示参数错误
操作	`operation`	enum	connect	否	指定本次执行的动作，默认 connect：connect 建立连接、send 发送数据、recv 接收并解帧、close 关闭连接；填入其它值返回 -1 并提示未知操作
发送数据	`data`	string	（空）	否	send 操作要发送的载荷文本，留空时 send 直接返回成功并提示跳过发送而不写出字节；非空时按组帧模式编码后发送并回填实际发送字节数
超时(ms)	`timeoutMs`	int	5000	否	连接与接收的超时毫秒数，默认 5000，connect 时用于设置接收超时；recv 在时限内未取到数据会返回 -1 并在运行信息提示接收失败或超时
组帧模式	`frameMode`	enum	length-prefix	否	组帧方式，默认 length-prefix：长度前缀帧按长度字段解帧、delimiter 按分隔符切帧、raw 不组帧按原始字节流透传；connect 时配置非法返回 -1 并提示组帧参数错误
长度字段字节数	`lengthFieldBytes`	int	4	否	仅 length-prefix 模式下生效的长度字段字节数，默认 4，可取 1、2、4、8；取值非法会使组帧配置校验失败，connect 返回 -1 并提示组帧参数错误
帧分隔符	`frameDelimiter`	string	\r\n	否	仅 delimiter 模式下生效的帧分隔符，默认回车换行且可含多字节，解帧时会从载荷中剔除；留空或配置非法时 connect 返回 -1 并在运行信息提示错误

输出参数 6

名称	keyId	类型	默认值	可连接	说明
运行结果	`resultCode`	int	—	否	0=对应操作成功完成并写出该操作的状态与数据；-1=参数非法、未连接、发送或接收失败、组帧错误及未知操作时返回，运行信息给出具体原因
运行信息	`resultInfo`	string	—	否	本次操作的执行状态描述，成功时写明连接复用、连接成功、已发送字节数或接收帧数，失败时给出参数错误、发送失败、接收超时等具体原因
响应	`response`	string	—	否	recv 操作解析出的载荷数据，非 raw 模式下为解帧得到的首帧内容，raw 模式下为收到的原始字节；send、connect、close 操作不写出该输出
已连接	`connected`	bool	—	否	操作结束时底层 TCP 连接是否处于已连接状态，connect 成功或复用常驻连接时为 true，自建连接执行 close 后为 false，常驻路径的 close 不改变其值
发送字节	`sent_bytes`	int	—	否	send 操作成功时实际写入底层的字节数，仅当本次确实发送了非空数据才写出；空数据跳过发送或发送失败时不产生该值
帧数	`frame_count`	int	—	否	recv 操作在本次调用中解出的完整帧数，非 raw 模式下等于解帧序列长度；一次收包可能解出多帧并提示改用完整帧序列，raw 模式不写出该值

接入方式

在 FlowDesigner 中将「TCP客户端」节点加入流程画布，把上游图像或数据连接至「通信配置ID」，并将「运行结果」接至下游节点。运行后可通过 VisionQuick 的数据绑定将结果呈现在界面组件上。

完整操作步骤参见使用文档；安装与使用问题可通过联系页反馈。

返回通信 TCP服务端 →

联系与反馈

获取安装包与技术反馈

安装包通过微信二维码获取。安装部署、界面组态与工具配置过程中的问题，可通过同一渠道反馈，无需注册或填写表单。

安装包获取与部署说明
界面组态与工具配置
功能建议与问题反馈

微信扫码 · 安装包与问题反馈