类: TCPClient

约 483 字大约 2 分钟

2026-03-18

构建固件和导入到JS

TCPClient 类由 mg 模块提供：

import { TCPClient } from 'mg'

简介

TCP 客户端类，用于建立原始 TCP 连接。

使用 mg.connect() 方法并传入 tcp:// 协议的 URL 来创建 TCPClient 实例。

示例：

import * as mg from 'mg'

let client = mg.connect('tcp://192.168.1.100:8080', (ev, data) => {
    if(ev=='open') {
        console.log('Connected')
        client.send('Hello Server')
    }
    else if(ev=='msg') {
        console.log('Received:', data)
    }
    else if(ev=='close') {
        console.log('Disconnected')
    }
})

类方法

方法 connect

原型: connect (url:string, callback:function)

建立 TCP 连接

通常通过 mg.connect() 调用，传入 tcp:// 协议的 URL。

回调函数原型： callback(event:string, data:ArrayBuffer): void

事件类型：

open: 连接已打开
connect: 连接已建立
msg: 收到数据，data 为 ArrayBuffer
close: 连接已关闭
error: 发生错误，data 为错误信息

参数:

url
类型string
参数说明连接地址，例如 "tcp://192.168.1.100:8080"
callback
类型function
参数说明事件回调函数

返回值:

类型TCPClient

说明返回 TCPClient 实例

方法 disconnect

原型: disconnect ()

断开 TCP 连接

返回值:

类型undefined

方法 send

原型: send (data:string|ArrayBuffer)

发送数据

参数:

data
类型string, ArrayBuffer
参数说明要发送的数据

返回值:

类型bool

说明发送成功返回 true，否则返回 false