uniapp原生插件 TCP Socket 使用文档

uniapp原生插件 TCP Socket 使用文档

试了插件市场几个TCP Socket插件都不能实现监听服务器主动断开,于是闲来无事就开发了一款,本插件是一个基于 Netty 实现的 TCP 通信模块,用于在 UniApp 插件中提供 TCP 连接、数据发送和连接管理功能。以下是模块的详细使用说明。




功能概述

  1. 打开 TCP 连接:通过指定的主机地址和端口号建立 TCP 连接。
  2. 发送数据:向已建立的 TCP 连接发送数据。
  3. 关闭 TCP 连接:断开当前的 TCP 连接并释放资源。
  4. 检查连接状态:查询当前 TCP 连接的状态。
  5. 设置连接状态:手动设置连接状态(内部使用)。

方法说明

1. 打开 TCP 连接

java 复制代码
openTcp(params, callback)
  • 参数

    • params (Object): 包含以下键值对:
    • host (String): 目标主机地址,例如 "127.0.0.1"
    • port (Integer/Double): 目标端口号,例如 8080
    • callback (Function): 回调函数,返回操作结果。
  • 回调返回值

    • code (Number): 状态码,1 表示成功,0 表示失败。
    • msg (String): 操作结果描述信息。
    • type (String): 操作类型,固定为 "CONNECTION_OPENED"
  • 示例

    javascript 复制代码
    tcpSocket.openTcp({
        host: "127.0.0.1",
        port: 8080
    }, (res) => {
        console.log(res);
    });

2. 发送数据

java 复制代码
sendData(params, callback)
  • 参数

    • params (Object): 包含以下键值对:
      • data (String): 要发送的数据内容。
      • callback (Function): 回调函数,返回操作结果。
  • 回调返回值

    • code (Number): 状态码,1 表示成功,0 表示失败。
    • msg (String): 操作结果描述信息。
    • data (String): 发送的数据内容(仅在成功时返回)。
    • type (String): 操作类型,固定为 "DATA_SENT"
  • 示例

    javascript 复制代码
    tcpSocket.sendData({
        data: "Hello, TCP!"
    }, (res) => {
        console.log(res);
    });

3. 关闭 TCP 连接

java 复制代码
closeTcp(callback)
  • 参数

    • callback (Function): 回调函数,返回操作结果。
  • 回调返回值

    • code (Number): 状态码,1 表示成功,0 表示失败。
    • msg (String): 操作结果描述信息。
    • type (String): 操作类型,固定为 "CONNECTION_CLOSED"
  • 示例

    javascript 复制代码
    tcpSocket.closeTcp((res) => {
        console.log(res);
    });

4. 检查 TCP 连接状态

java 复制代码
isTcpConnected(callback)
  • 参数

    • callback (Function): 回调函数,返回操作结果。
  • 回调返回值

    • code (Number): 状态码,1 表示成功,0 表示失败。
    • msg (String): 操作结果描述信息。
    • connected (Boolean): 当前连接状态,true 表示已连接,false 表示未连接。
    • type (String): 操作类型,固定为 "STATUS_CHECKED"
  • 示例

    javascript 复制代码
    tcpSocket.isTcpConnected((res) => {
        console.log(res.connected); // true 或 false
    });

注意事项

  1. 异常处理

    • 如果发生异常,所有方法都会通过回调返回错误信息,请确保正确处理异常情况。
  2. 字符编码

    • 数据传输默认使用 GBK 编码,确保发送和接收方的编码一致。
  3. 资源释放

    • 在不再需要 TCP 连接时,务必调用closeTcp方法以释放资源。

示例代码

以下是一个完整的使用示例:

javascript 复制代码
// 打开 TCP 连接
tcpSocket.openTcp({
    host: "127.0.0.1",
    port: 8080
}, (res) => {
    if (res.code === 1) {
        console.log("TCP 连接已建立");

        // 发送数据
        tcpSocket.sendData({
            data: "Hello, TCP!"
        }, (sendRes) => {
            if (sendRes.code === 1) {
                console.log("数据发送成功");
            } else {
                console.error("数据发送失败:", sendRes.msg);
            }

            // 关闭 TCP 连接
            tcpSocket.closeTcp((closeRes) => {
                console.log(closeRes.msg);
            });
        });
    } else {
        console.error("无法建立 TCP 连接:", res.msg);
    }
});

以上是 tcpSocket 模块的完整使用文档。如有其他问题,请参考源码或联系开发者。

相关推荐
李白你好1 小时前
常见网络端口号及端口查看命令
网络
2301_803554524 小时前
HTTP 常考问题简洁回答(速记版)
网络·网络协议·http
无聊的小坏坏4 小时前
从零开始:C++ 多线程 TCP 服务器实战(续篇)
服务器·c++·tcp/ip
捷米研发三部6 小时前
Profinet 转 TCP/IP 协议转换网关:打破 PLC 与打标卡协议壁垒的工业通讯利器
网络·网络协议·tcp/ip
TeleostNaCl8 小时前
OpenWrt | 实现限制只有指定设备才能访问 luci 和 使用 SSH 等方式管理设备的方法
网络·经验分享·ssh·智能路由器
蒙娜丽宁8 小时前
Rust 并发编程进阶:线程模型、通道通信与异步任务对比分析
开发语言·网络·rust
Teable任意门互动9 小时前
主流多维表格产品深度解析:飞书、Teable、简道云、明道云、WPS
开发语言·网络·开源·钉钉·飞书·开源软件·wps
报错小能手10 小时前
计算机网络自顶向下方法2——网络、ISP连接结构介绍
网络·计算机网络
-Excalibur-10 小时前
形象解释关于TCP/IP模型——层层封装MAC数据帧的过程
linux·c语言·网络·笔记·单片机·网络协议·tcp/ip
小跌—10 小时前
Linux:数据链路层
linux·网络