创建TCP客户端 - TcpClientCreate

函数简介

创建TCP客户端（基于回调的事件驱动模式）。

接口名称

TcpClientCreate

DLL调用

int64_t TcpClientCreate(int64_t instance, TcpClientCallback callback, int64_t user_data, int32_t enable_packet_protocol)

参数说明

参数名类型说明
instanceint64_tOLAPlug对象的指针
callbackTcpClientCallback事件回调函数
user_dataint64_t用户自定义数据，会在回调时传回
enable_packet_protocolint32_t是否启用消息分包协议：1=启用（推荐），0=禁用（原始模式）

回调函数类型定义

void TcpClientCallback(int64_t client_handle, int32_t event_type, int64_t data, int32_t data_len, int64_t user_data);

回调函数说明：当TCP客户端发生各种事件时，系统会调用此类型的回调函数。回调函数在独立线程中执行，注意线程安全。

回调参数说明：

参数名类型说明
client_handleint64_t客户端句柄
event_typeint32_t事件类型（详见下方事件类型表）
dataint64_t数据指针（仅当 event_type=2 时有效，指向接收到的数据）
data_lenint32_t数据长度（仅当 event_type=2 时有效）
user_dataint64_t用户自定义数据，由创建客户端时传入

事件类型说明：

event_type事件名称说明
0连接成功成功连接到服务器
1连接失败连接服务器失败
2接收数据接收到数据（data指向数据，data_len为长度）
3连接断开与服务器的连接已断开
4发送完成数据发送完成

示例

// 回调函数
void OnTcpClientEvent(int64_t client_handle, int32_t event_type, 
                      int64_t data, int32_t data_len, int64_t user_data) {
    switch (event_type) {
        case 0:  // 连接成功
            printf("连接成功\n");
            // 发送数据
            const char* msg = "Hello Server";
            TcpClientSend(instance, client_handle, (int64_t)msg, strlen(msg));
            break;
            
        case 1:  // 连接失败
            printf("连接失败\n");
            break;
            
        case 2:  // 接收到数据
            printf("收到数据：%.*s\n", data_len, (char*)data);
            break;
            
        case 3:  // 连接断开
            printf("连接断开\n");
            break;
            
        case 4:  // 发送完成
            printf("发送完成\n");
            break;
    }
}

// 创建客户端（启用分包协议）
int64_t client = TcpClientCreate(instance, OnTcpClientEvent, 0, 1);
if (client != 0) {
    // 连接服务器
    TcpClientConnect(instance, client, "127.0.0.1", 8080);
}

// 创建客户端（原始模式，不分包）
int64_t rawClient = TcpClientCreate(instance, OnTcpClientEvent, 0, 0);

返回值

返回值类型说明
int64_t客户端句柄，失败返回0

注意事项

  • 消息分包协议（enable_packet_protocol=1）：
    • 格式：[4字节长度前缀(小端序)][消息体]
    • 自动解决TCP粘包问题
    • 推荐用于自定义协议通信
  • 原始模式（enable_packet_protocol=0）：
    • 不添加任何协议头
    • 可能出现粘包问题
    • 适用于与第三方系统通信
  • 回调函数在独立线程中执行，注意线程安全
  • 使用完毕后需要调用 TcpClientDestroy 释放资源
Last Updated: