创建TCP服务端 - TcpServerCreate

函数简介

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

接口名称

TcpServerCreate

DLL调用

int64_t TcpServerCreate(int64_t instance, const char* bind_addr, int32_t port, TcpServerCallback callback, int64_t user_data, int32_t enable_packet_protocol)

参数说明

参数名类型说明
instanceint64_tOLAPlug对象的指针
bind_addrstring绑定地址，空或"0.0.0.0"表示所有接口
portint32_t端口号
callbackTcpServerCallback事件回调函数
user_dataint64_t用户自定义数据，会在回调时传回
enable_packet_protocolint32_t是否启用消息分包协议：1=启用（推荐），0=禁用（原始模式）

回调函数类型定义

void TcpServerCallback(int64_t server_handle, int64_t conn_id, int32_t event_type, int64_t data, int32_t data_len, int64_t user_data);

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

回调参数说明：

参数名类型说明
server_handleint64_t服务端句柄
conn_idint64_t连接ID（用于标识不同的客户端连接）
event_typeint32_t事件类型（详见下方事件类型表）
dataint64_t数据指针（仅当 event_type=1 时有效，指向接收到的数据）
data_lenint32_t数据长度（仅当 event_type=1 时有效）
user_dataint64_t用户自定义数据，由创建服务端时传入

事件类型说明：

event_type事件名称说明
0新连接有新客户端连接到服务器（conn_id为新连接的ID）
1接收数据从客户端接收到数据（data指向数据，data_len为长度）
2连接断开客户端断开连接（conn_id为断开的连接ID）
3发送完成数据发送完成

示例

// 回调函数
void OnTcpServerEvent(int64_t server_handle, int64_t conn_id, int32_t event_type,
                      int64_t data, int32_t data_len, int64_t user_data) {
    switch (event_type) {
        case 0:  // 新连接
            printf("新连接：conn_id=%lld\n", conn_id);
            
            // 获取客户端地址
            const char* addr = TcpServerGetClientAddress(instance, server_handle, conn_id);
            if (addr != NULL) {
                printf("客户端地址：%s\n", addr);
                FreeStringPtr(instance, addr);
            }
            break;
            
        case 1:  // 接收到数据
            printf("收到数据[conn_id=%lld]：%.*s\n", conn_id, data_len, (char*)data);
            
            // 回复客户端
            const char* reply = "OK";
            TcpServerSend(instance, server_handle, conn_id, (int64_t)reply, strlen(reply));
            break;
            
        case 2:  // 连接断开
            printf("连接断开：conn_id=%lld\n", conn_id);
            break;
            
        case 3:  // 发送完成
            printf("发送完成[conn_id=%lld]\n", conn_id);
            break;
    }
}

// 创建服务端（监听所有接口，端口8080）
int64_t server = TcpServerCreate(instance, "0.0.0.0", 8080, OnTcpServerEvent, 0, 1);
if (server != 0) {
    printf("服务端启动成功，监听端口：8080\n");
}

// 创建服务端（只监听本地）
int64_t localServer = TcpServerCreate(instance, "127.0.0.1", 9000, OnTcpServerEvent, 0, 1);

// 创建服务端（原始模式，不分包）
int64_t rawServer = TcpServerCreate(instance, "0.0.0.0", 8081, OnTcpServerEvent, 0, 0);

返回值

返回值类型说明
int64_t服务端句柄，失败返回0

注意事项

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